[
][
C:
/
Program Files (x86)
/
AWS Tools
/
PowerShell
/
AWSPowerShell
/]
Upload
Terminal
File Manager
Server Info
Current File :
C:/Program Files (x86)/AWS Tools/PowerShell/AWSPowerShell/AWSPowerShell.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>Clear-AWSHistory</name> <description> <para>Clears the contents of the AWS cmdlet history buffer ($AWSHistory) in the current shell.</para> </description> <verb>Clear</verb> <noun>AWSHistory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Clears the contents of the AWS cmdlet history buffer ($AWSHistory) in the current shell. </para> </description> <syntax> <syntaxItem> <name>Clear-AWSHistory</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Clear-AWSHistory.html&tocid=Clear-AWSHistory</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>Set-AWSHistoryConfiguration</name> <description> <para>Configures how the $AWSHistory session variable records AWS cmdlet processing.</para> </description> <verb>Set</verb> <noun>AWSHistoryConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Configures the $AWSHistory instance for the current session. A history buffer size of 0 disables overall AWS cmdlet activity recording and clears any data currently in the buffer. If the new size is smaller than the current data in the buffer, older records are deleted. By default, only service responses are recorded for a cmdlet. Use the -EnableRequestRecording switch to turn on tracing of service requests in the buffer. </para> </description> <syntax> <syntaxItem> <name>Set-AWSHistoryConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxCmdletHistory</name> <description> <para>The maximum number of AWS cmdlet invocations that will be held in the history buffer. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxServiceCallHistory</name> <description> <para>The maximum number of service responses (and requests, if enabled) that will be recorded for a single AWS cmdlet. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RecordServiceRequests</name> <description> <para>If set, also records the service requests that a cmdlet makes. Default: Off. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxCmdletHistory</name> <description> <para>The maximum number of AWS cmdlet invocations that will be held in the history buffer. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxServiceCallHistory</name> <description> <para>The maximum number of service responses (and requests, if enabled) that will be recorded for a single AWS cmdlet. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RecordServiceRequests</name> <description> <para>If set, also records the service requests that a cmdlet makes. Default: Off. </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> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-AWSHistoryConfiguration.html&tocid=Set-AWSHistoryConfiguration</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>Initialize-AWSDefaultConfiguration</name> <description> <para>Creates or updates the credential profile named 'default' using supplied keys, existing credentials or profile, or EC2 metadata. The profile and a default region is then set active in the current shell.</para> </description> <verb>Initialize</verb> <noun>AWSDefaultConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates or updates the credential profile named 'default' and sets the profile, and optionally a region, as active in the current shell. The credential data to be stored in the 'default' profile can be provided from: -Supplied access and secret key parameters for AWS credentials -A pre-existing profile -A credentials object -Active credentials in the current shell (in the variable $StoredAWSCredentials) -EC2 role metadata (for instances launched with instance profiles) A default region to assume when the default profile is active is also set using the -Region parameter, from a default region already set in the current shell or, if the cmdlet is executing on an EC2 instance, from the instance metadata. If a region setting cannot be determined from a parameter or the shell you are prompted to select one. Note that if run on an EC2 instance and you want to select a region other than the region containing the instance you should supply the -Region parameter so that the cmdlet does not inspect EC2 instance metadata to auto-discover the region. In all cases a profile named 'default' will be created or updated to contain the specified credential and region data. Note that if the credential source is another profile this cmdlet effectively copies the credential data from the source profile to the 'default' profile. When the cmdlet exits the active credentials can be accessed in the shell via a variable named $StoredAWSCredentials. The active region can be found in the variable $StoredAWSRegion. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Initialize-AWSDefaults</i>. </para> </description> <syntax> <syntaxItem> <name>Initialize-AWSDefaultConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.ProfileLocation </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Initialize-AWSDefaultConfiguration</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="201"> <name>ProfileName</name> <description> <para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.ProfileLocation </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="211"> <name>Region</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.Region </para> </description> <parameterValue required="true" variableLength="false">System.Object</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NetworkCredential</name> <description> <para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Initialize-AWSDefaultConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.ProfileLocation </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="211"> <name>Region</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.Region </para> </description> <parameterValue required="true" variableLength="false">System.Object</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AccessKey</name> <description> <para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecretKey</name> <description> <para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SessionToken</name> <description> <para>The session token if the access and secret keys are temporary session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Initialize-AWSDefaultConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.ProfileLocation </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="211"> <name>Region</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.Region </para> </description> <parameterValue required="true" variableLength="false">System.Object</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ExternalID</name> <description> <para>The user-defined external ID to be used when assuming a role, if required by the role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MfaSerial</name> <description> <para>The MFA serial number to be used when assuming a role, if required by the role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RoleArn</name> <description> <para>The ARN of the role to assume for assume role credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceProfile</name> <description> <para>The name of the source profile to be used by assume role credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Initialize-AWSDefaultConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.ProfileLocation </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="211"> <name>Region</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.Region </para> </description> <parameterValue required="true" variableLength="false">System.Object</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>Credential</name> <description> <para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Initialize-AWSDefaultConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.ProfileLocation </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="211"> <name>Region</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.Region </para> </description> <parameterValue required="true" variableLength="false">System.Object</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AccessKey</name> <description> <para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </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, )" position="Named"> <name>Credential</name> <description> <para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue> <type> <name>Amazon.Runtime.AWSCredentials</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ExternalID</name> <description> <para>The user-defined external ID to be used when assuming a role, if required by the role. </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>MfaSerial</name> <description> <para>The MFA serial number to be used when assuming a role, if required by the role. </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>NetworkCredential</name> <description> <para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> <type> <name>System.Management.Automation.PSCredential</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.ProfileLocation </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 (ByPropertyName)" position="201"> <name>ProfileName</name> <description> <para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </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 (ByPropertyName)" position="211"> <name>Region</name> <description> <para>Amazon.PowerShell.Common.InitializeDefaultConfigurationCmdlet+InitializeDefaultConfigurationCmdletParameters.Region </para> </description> <parameterValue required="true" variableLength="false">System.Object</parameterValue> <type> <name>System.Object</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RoleArn</name> <description> <para>The ARN of the role to assume for assume role credentials. </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 (ByPropertyName)" position="Named"> <name>SecretKey</name> <description> <para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </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>SessionToken</name> <description> <para>The session token if the access and secret keys are temporary session-based credentials. </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 (ByPropertyName)" position="Named"> <name>SourceProfile</name> <description> <para>The name of the source profile to be used by assume role credentials. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Initialize-AWSDefaultConfiguration.html&tocid=Initialize-AWSDefaultConfiguration</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Initialize-AWSDefaultConfiguration</code><remarks><para>Description</para><para>-----------</para><para>Tests to see if a profile named 'default' exists. If it does the credential and region data in the profile are loaded and set as active in the current shell. If a 'default' profile does not exist and the cmdlet is running on the local workstation the user is prompted to enter the AWS access and secret keys for an account, and to select a default region. If run on an Amazon EC2 instance the instance metadata is inspected to determine if the instance was launched with a role and if so credentials are obtained from the role before prompting for a default region. The credentials and region selection are then saved into a profile named 'default' and set as active in the current shell.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Initialize-AWSDefaultConfiguration -AccessKey AKIAIOSFODNN7EXAMPLE -SecretKey wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -Region us-west-2</code><remarks><para>Description</para><para>-----------</para><para>Saves the specified credential keys and default region selection to a profile named 'default'. On exit the credentials and region are set as active in the current shell.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Initialize-AWSDefaultConfiguration -ProfileName myProfile -Region us-west-2</code><remarks><para>Description</para><para>-----------</para><para>Loads the credential data from the profile named 'myProfile' and saves it to a profile named 'default' (effectively copying credential data from one profile to another). The default profile is also updated to assume a default region of 'us-west-2'. When the cmdlet exists the specified credentials and region are set active in the current shell.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\>Initialize-AWSDefaultConfiguration -Region us-west-2</code><remarks><para>Description</para><para>-----------</para><para>If a profile named 'default' exists it is updated to assume a default region of 'us-west-2'. If the profile does not exist and the cmdlet is running on the local workstation the user is prompted to enter the AWS access and secret keys for an account. If run on an Amazon EC2 instance the instance metadata is inspected to determine if the instance was launched with a role and if so credentials are obtained from the role. A profile named 'default' is then created containing the discovered or entered credentials and region, and the current shell updated to set thenm active.</para><para /><para /></remarks> </example> </examples> </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>Clear-AWSDefaultConfiguration</name> <description> <para>Clears the persisted credentials associated with the credential profile names 'default' and 'AWS PS Default', plus any credentials and region data currently set in the session's shell variables. To clear the stored default credentials only, use the -SkipShell parameter. To affect the current shell only, use the -SkipProfileStore parameter.</para> </description> <verb>Clear</verb> <noun>AWSDefaultConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Clears the persisted credentials associated with the credential profile names 'default' and 'AWS PS Default', plus any credentials and region data currently set in the session's shell variables. To clear the stored default credentials only, use the -SkipShell parameter. To affect the current shell only, use the -SkipProfileStore parameter. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Clear-AWSDefaults</i>. </para> </description> <syntax> <syntaxItem> <name>Clear-AWSDefaultConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SkipShell</name> <description> <para>If set, the cmdlet will not clear the current shell state. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SkipProfileStore</name> <description> <para>If set, the cmdlet will not clear the 'default' and 'AWS PS Default' profiles held in the credentials store. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio for the 'default' and 'AWS PS Default' profiles. If the profiles are not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio for the 'default' and 'AWS PS Default' profiles. If the profiles are not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </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="False" position="Named"> <name>SkipProfileStore</name> <description> <para>If set, the cmdlet will not clear the 'default' and 'AWS PS Default' profiles held in the credentials store. </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="False" position="Named"> <name>SkipShell</name> <description> <para>If set, the cmdlet will not clear the current shell state. </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> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Clear-AWSDefaultConfiguration.html&tocid=Clear-AWSDefaultConfiguration</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>Get-AWSPowerShellVersion</name> <description> <para>Displays version and copyright information for the AWS Tools for Windows PowerShell to the shell. If the ListServiceVersionInfo switch is specifiedthe services and their API versions supported by this module are also displayed.</para> </description> <verb>Get</verb> <noun>AWSPowerShellVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Writes version and copyright information for the AWSPowerShell integration to the shell. If the ListServices switch is specified the services and their API versions supported by this module are also displayed. </para> </description> <syntax> <syntaxItem> <name>Get-AWSPowerShellVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListServiceVersionInfo</name> <description> <para>If specified the cmdlet also lists all supported AWS services and their versions. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListServiceVersionInfo</name> <description> <para>If specified the cmdlet also lists all supported AWS services and their versions. </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> </parameters> <returnValues> <returnValue> <type> <name>String</name> <uri /> <description /> </type> <description> <para>Version information for the tools and optionally supported services.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-AWSPowerShellVersion.html&tocid=Get-AWSPowerShellVersion</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>New-AWSCredential</name> <description> <para>Returns a populated AWSCredentials instance.</para> </description> <verb>New</verb> <noun>AWSCredential</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates and returns an AWSCredentials object Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>New-AWSCredentials</i>. </para> </description> <syntax> <syntaxItem> <name>New-AWSCredential</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="201"> <name>ProfileName</name> <description> <para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NetworkCredential</name> <description> <para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>New-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AccessKey</name> <description> <para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecretKey</name> <description> <para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SessionToken</name> <description> <para>The session token if the access and secret keys are temporary session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>New-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ExternalID</name> <description> <para>The user-defined external ID to be used when assuming a role, if required by the role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MfaSerial</name> <description> <para>The MFA serial number to be used when assuming a role, if required by the role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RoleArn</name> <description> <para>The ARN of the role to assume for assume role credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceProfile</name> <description> <para>The name of the source profile to be used by assume role credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>New-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>Credential</name> <description> <para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AccessKey</name> <description> <para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </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, )" position="Named"> <name>Credential</name> <description> <para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue> <type> <name>Amazon.Runtime.AWSCredentials</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ExternalID</name> <description> <para>The user-defined external ID to be used when assuming a role, if required by the role. </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>MfaSerial</name> <description> <para>The MFA serial number to be used when assuming a role, if required by the role. </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>NetworkCredential</name> <description> <para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> <type> <name>System.Management.Automation.PSCredential</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </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 (ByPropertyName)" position="201"> <name>ProfileName</name> <description> <para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </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 (ByPropertyName)" position="Named"> <name>RoleArn</name> <description> <para>The ARN of the role to assume for assume role credentials. </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 (ByPropertyName)" position="Named"> <name>SecretKey</name> <description> <para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </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>SessionToken</name> <description> <para>The session token if the access and secret keys are temporary session-based credentials. </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 (ByPropertyName)" position="Named"> <name>SourceProfile</name> <description> <para>The name of the source profile to be used by assume role credentials. </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>AWSCredentials</name> <uri /> <description /> </type> <description> <para>AWSCredentials instance containing AWS credentials data.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-AWSCredential.html&tocid=New-AWSCredential</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>Set-AWSCredential</name> <description> <para>Saves AWS credentials to persistent store (-StoreAs) or temporarily for the shell using shell variable $StoredAWSCredentials.Note that temporary session-based credentials cannot be saved to the persistent store.</para> </description> <verb>Set</verb> <noun>AWSCredential</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Saves AWS credentials to persistent store (-StoreAs) or temporarily for the shell using shell variable $StoredAWSCredentials. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Set-AWSCredentials</i>. </para> </description> <syntax> <syntaxItem> <name>Set-AWSCredential</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="201"> <name>ProfileName</name> <description> <para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>StoreAs</name> <description> <para>Amazon.PowerShell.Common.SetCredentialCmdlet+SetCredentialsParameters.StoreAs </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NetworkCredential</name> <description> <para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Set-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>StoreAs</name> <description> <para>Amazon.PowerShell.Common.SetCredentialCmdlet+SetCredentialsParameters.StoreAs </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AccessKey</name> <description> <para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecretKey</name> <description> <para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SessionToken</name> <description> <para>The session token if the access and secret keys are temporary session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Set-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>StoreAs</name> <description> <para>Amazon.PowerShell.Common.SetCredentialCmdlet+SetCredentialsParameters.StoreAs </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ExternalID</name> <description> <para>The user-defined external ID to be used when assuming a role, if required by the role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MfaSerial</name> <description> <para>The MFA serial number to be used when assuming a role, if required by the role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RoleArn</name> <description> <para>The ARN of the role to assume for assume role credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceProfile</name> <description> <para>The name of the source profile to be used by assume role credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Set-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>StoreAs</name> <description> <para>Amazon.PowerShell.Common.SetCredentialCmdlet+SetCredentialsParameters.StoreAs </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>Credential</name> <description> <para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AccessKey</name> <description> <para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </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, )" position="Named"> <name>Credential</name> <description> <para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue> <type> <name>Amazon.Runtime.AWSCredentials</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ExternalID</name> <description> <para>The user-defined external ID to be used when assuming a role, if required by the role. </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>MfaSerial</name> <description> <para>The MFA serial number to be used when assuming a role, if required by the role. </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>NetworkCredential</name> <description> <para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> <type> <name>System.Management.Automation.PSCredential</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="202"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </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 (ByPropertyName)" position="201"> <name>ProfileName</name> <description> <para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </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 (ByPropertyName)" position="Named"> <name>RoleArn</name> <description> <para>The ARN of the role to assume for assume role credentials. </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 (ByPropertyName)" position="Named"> <name>SecretKey</name> <description> <para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </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>SessionToken</name> <description> <para>The session token if the access and secret keys are temporary session-based credentials. </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 (ByPropertyName)" position="Named"> <name>SourceProfile</name> <description> <para>The name of the source profile to be used by assume role credentials. </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>StoreAs</name> <description> <para>Amazon.PowerShell.Common.SetCredentialCmdlet+SetCredentialsParameters.StoreAs </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-AWSCredential.html&tocid=Set-AWSCredential</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Set-AWSCredential -ProfileName myCredentials</code><remarks><para>Description</para><para>-----------</para><para>Loads the credentials contained in the specified profile and sets them active for all cmdlets in the current shell (the parameter name can be omitted for brevity). The cmdlet first searches the encrypted credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. If this file does not contain a matching profile the cmdlet will attempt to load the profile from the text-format credential file shared with the AWS CLI, looking in its default location (%USERPROFILE%\.aws\credentials). If this file has been renamed, or does not exist in the default location, use the -ProfileLocation parameter to point to the credential file. Note that using -ProfileLocation disables profile lookup in the encrypted .NET store file.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Set-AWSCredential -AccessKey AKIAIOSFODNN7EXAMPLE -SecretKey wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -StoreAs myCredentials</code><remarks><para>Description</para><para>-----------</para><para>Saves the specified credentials as a profile named 'myCredentials'. The cmdlet does not affect any credentials currently set as active in the shell. To update the shell run the cmdlet again specifying the name of the profile (Set-AWSCredential -ProfileName myCredentials). On platforms that support the encrypted credential file the profile is written to the encrypted store. If the platform does not support the encrypted store (Linux, MacOS, Windows Nano Server) the profile is written to the plain text ini-format shared credential file at %HOME%\.aws\credentials. To force the profile to be written to the shared credential file on systems that support both stores, specify the path and filename of the credential file using the -ProfileLocation parameter.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Set-AWSCredential -AccessKey AKIAIOSFODNN7EXAMPLE -SecretKey wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -SessionToken SamPleTokeN.....</code><remarks><para>Description</para><para>-----------</para><para>Sets the temporary session-based credentials as active in the current shell. Note that temporary credentials cannot be saved as a profile.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\>Set-AWSCredential -ProfileName myCredentials -ProfileLocation C:\myAWSCredentials.ini</code><remarks><para>Description</para><para>-----------</para><para>Loads the specified credentials from the ini-format credential file (with a non-default name and location) shared with the AWS CLI and sets the credentials in the profile active in the current shell. The -ProfileLocation parameter can be omitted if the credential file is named 'credentials' and is stored in the default location (%USERPROFILE%\.aws).</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code> PS C:\> $credential = Get-Credential -Message "Enter your domain credentials for federated identity" PS C:\> Set-AWSCredential -ProfileName mySamlCredentialProfile -NetworkCredential $credential </code><remarks><para>Description</para><para>-----------</para><para>Loads the specifed SAML federated credential profile (created with Set-AWSSAMLRoleProfile). The -NetworkCredential parameter is only needed if the logged-in user acount is not joined to the domain used for federation. In this scenario, when temporary credential generated is attempted and the user must be authenticated, caching the identity with the -NetworkCredential parameter value avoids a pop-up credential demand. For systems where the logged-in user account belongs to the domain the logged-in identity is used automatically and no credential demand is made. In this scenario you do not need to supply a credential value.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 6 --------------------------</title><code> PS C:\> Set-AWSCredential -AccessKey AKIAIOSFODNN7EXAMPLE -SecretKey wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -StoreAs sourceAccountProfile PS C:\> Set-AWSCredential -SourceProfile sourceAccountProfile -RoleArn arn:aws:iam::123456789012:role/my_role -StoreAs myRoleProfile </code><remarks><para>Description</para><para>-----------</para><para>Creates a cross-account role profile for the specified role. First you create a source profile that can be referenced by multiple role profiles. Then create the role profile for the specified role(s). When the role profile is loaded for use, the role described in the profile will be assumed and temporary credentials for the role set as active in the shell.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 7 --------------------------</title><code>PS C:\>Set-AWSCredential -SourceProfile sourceAccountProfile -RoleArn arn:aws:iam::123456789012:role/my_role -MfaSerial 124345 -StoreAs myRoleProfile</code><remarks><para>Description</para><para>-----------</para><para>Creates a cross-account role profile for the specified role that requires use of a two-factor MFA device during credential generation. When credentials for the role are generated the user is prompted to enter the value on the MFA device.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 8 --------------------------</title><code>PS C:\>Set-AWSCredential -SourceProfile sourceAccountProfile -RoleArn arn:aws:iam::123456789012:role/my_role -ExternalId idValue -StoreAs myRoleProfile</code><remarks><para>Description</para><para>-----------</para><para>Creates a cross-account role profile for the specified role that requires a unique identifier to be specified. The identifier is used by third parties when assuming roles in their customers' accounts.</para><para /><para /></remarks> </example> </examples> </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>Clear-AWSCredential</name> <description> <para>Clears the set of AWS credentials currently set as default in the shell or, if supplied with a name, deletes the set of credentials associated with the supplied name from the local credentials store.</para> </description> <verb>Clear</verb> <noun>AWSCredential</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Clears the set of AWS credentials currently set as default in the shell or, if supplied with a name, deletes the set of credentials associated with the supplied name from the local credentials store. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Clear-AWSCredentials</i>. </para> </description> <syntax> <syntaxItem> <name>Clear-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProfileName</name> <description> <para>The name associated with a set of credentials in the local store that are to be deleted. If not specified, the default credentials in the shell are cleared. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </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="False" position="Named"> <name>ProfileName</name> <description> <para>The name associated with a set of credentials in the local store that are to be deleted. If not specified, the default credentials in the shell are cleared. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Clear-AWSCredential.html&tocid=Clear-AWSCredential</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Clear-AWSCredential</code><remarks><para>Description</para><para>-----------</para><para>Clears any credentials set as default in the current shell. The stored profiles are not affected.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Clear-AWSCredential -ProfileName myCredentials</code><remarks><para>Description</para><para>-----------</para><para>Deletes the credential profile named 'myCredentials'.</para><para /><para /></remarks> </example> </examples> </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>Get-AWSCredential</name> <description> <para>Returns an AWSCredentials object initialized with from either credentials currently set as default in the shell or saved and associated with the supplied name from a local credential store. Optionally the cmdlet can list the names, types, and locations of all sets of credentials held in the store.</para> </description> <verb>Get</verb> <noun>AWSCredential</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an AWSCredentials object initialized with from either credentials currently set as default in the shell or saved and associated with the supplied name from the local credential store. Optionally the cmdlet can list the names, types, and locations of all sets of credentials held in local stores. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Get-AWSCredentials</i>. </para> </description> <syntax> <syntaxItem> <name>Get-AWSCredential</name> </syntaxItem> <syntaxItem> <name>Get-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ProfileName</name> <description> <para>The name associated with the credentials in local storage </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Get-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListProfile</name> <description> <para>Lists the names of all CredentialProfiles saved in local storage </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Get-AWSCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListProfileDetail</name> <description> <para>List the name, type, and location of all CredentialProfiles saved in local storage </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListProfile</name> <description> <para>Lists the names of all CredentialProfiles saved in local storage </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="False" position="Named"> <name>ListProfileDetail</name> <description> <para>List the name, type, and location of all CredentialProfiles saved in local storage </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="False" position="Named"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </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="False" position="2"> <name>ProfileName</name> <description> <para>The name associated with the credentials in local storage </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.Runtime.AWSCredentials</name> <uri /> <description /> </type> <description> <para>Object containing a set of AWS credentials.</para> </description> </returnValue> <returnValue> <type> <name>String</name> <uri /> <description /> </type> <description> <para>The set of names associated with saved credentials in local stores.</para> </description> </returnValue> <returnValue> <type> <name>Amazon.Powershell.Common.ProfileInfo</name> <uri /> <description /> </type> <description> <para>The set of names, types, and locations associated with saved credentials in local stores.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-AWSCredential.html&tocid=Get-AWSCredential</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>Set-AWSSamlEndpoint</name> <description> <para>Creates or updates an endpoint settings definition for use with SAML role profiles.</para> </description> <verb>Set</verb> <noun>AWSSamlEndpoint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates or updates an endpoint settings definition for use with SAML role profiles. The name of the endpoint settings is used with the Set-AWSSamlRoleProfile and Set-AWSCredentials cmdlets to associate one or more role profiles to a shared endpoint definition. </para> </description> <syntax> <syntaxItem> <name>Set-AWSSamlEndpoint</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>Endpoint</name> <description> <para>The endpoint to be used when authenticating users prior to requesting temporary role- based AWS credentials. The full endpoint of the identity provider must be specified and it must be a HTTPS-scheme URL. </para> </description> <parameterValue required="true" variableLength="false">System.Uri</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StoreAs</name> <description> <para>The user-defined name to assign to the endpoint settings. This name will be used when creating or accessing role profiles with the Set-AWSSamlRoleProfile cmdlet to set up and use role-based credential profiles that use the endpoint to authenticate the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationType</name> <description> <para>The authentication type (or protocol type) used when communicating with the endpoint. If not configured for an endpoint 'Kerberos' is assumed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationType</name> <description> <para>The authentication type (or protocol type) used when communicating with the endpoint. If not configured for an endpoint 'Kerberos' is assumed. </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, )" position="Named"> <name>Endpoint</name> <description> <para>The endpoint to be used when authenticating users prior to requesting temporary role- based AWS credentials. The full endpoint of the identity provider must be specified and it must be a HTTPS-scheme URL. </para> </description> <parameterValue required="true" variableLength="false">System.Uri</parameterValue> <type> <name>System.Uri</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StoreAs</name> <description> <para>The user-defined name to assign to the endpoint settings. This name will be used when creating or accessing role profiles with the Set-AWSSamlRoleProfile cmdlet to set up and use role-based credential profiles that use the endpoint to authenticate the user. </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>System.String</name> <uri /> <description /> </type> <description> <para>The cmdlet returns the name assigned to the endpoint settings to the pipeline.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-AWSSamlEndpoint.html&tocid=Set-AWSSamlEndpoint</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> $endpoint = "https://adfs.example.com/adfs/ls/IdpInitiatedSignOn.aspx?loginToRp=urn:amazon:webservices" PS C:\> Set-AWSSamlEndpoint -StoreAs MyADFSEndpoint -Endpoint $endpoint </code><remarks><para>Description</para><para>-----------</para><para>Creates or updates a profile name MyADFSEndpoint for use with Set-AWSSamlRoleProfile. Kerberos will be used as the authentication protocol when authenticating users against the endoint.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> $endpoint = "https://adfs.example.com/adfs/ls/IdpInitiatedSignOn.aspx?loginToRp=urn:amazon:webservices" PS C:\> Set-AWSSamlEndpoint -StoreAs MyADFSEndpoint -Endpoint $endpoint -AuthenticationType NTLM </code><remarks><para>Description</para><para>-----------</para><para>Creates or updates a profile name MyADFSEndpoint for use with Set-AWSSamlRoleProfile. The endpoint is configured to use the NTLM protocol during authentication (other options are Digest, Basic, Kerberos and Negotiate).</para><para /><para /></remarks> </example> </examples> </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>Set-AWSSamlRoleProfile</name> <description> <para>Creates or updates one or more role profiles for use with authentication against a SAML-based federated identity provider to obtain temporary role-based AWS credentials.</para> </description> <verb>Set</verb> <noun>AWSSamlRoleProfile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates or updates role profiles for use with a SAML federated identity provider to obtain temporary AWS credentials for roles the user is authorized to assume. The endpoint for authentication should have been configured previously using Set-AWSSamlEndpoint. Once created the role profiles can be used to obtain time-limited temporary AWS credentials by specifying the name of the role profile to the -ProfileName parameter of the Set-AWSCredentials cmdlet or any cmdlet that makes calls to AWS service operations. <br /><br /> User authentication is not performed until AWS credentials are required, i.e. just prior to a service operation call. Additionally if the credentials expire then the tools will automatically attempt to re-authenticate the user to obtain fresh credentials. When a role profile is configured to use the default logged-in user identity then this process happens silently. If a role profile is configured to use an alternate identity (by specifying the -NetworkCredential parameter) the user is prompted to re-enter their credentials prior to re-authentication. </para> </description> <syntax> <syntaxItem> <name>Set-AWSSamlRoleProfile</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>EndpointName</name> <description> <para>The name assigned to the endpoint definition that was previously registered using Set-AWSSamlEndpoint. The endpoint definition contains the URL of the endpoint to be used to authenticate users prior to vending temporary AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrincipalARN</name> <description> <para>The Amazon Resource Name (ARN) of the principal holding the role to be assumed when credentials are requested following successful authentication. If specified the RoleARN parameter must also be specified. <br /><br /> If neither of the PrincipalARN and RoleARN parameters are supplied and the user is authorized to assume multiple roles the cmdlet will prompt to select the role that should be referenced by the profile. The user is also prompted if ARNs are specified but cannot be found in the data returned on successful authentication. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The Amazon Resource Name (ARN) of the role to be assumed when credentials are requested following successful authentication. If specified the PrincipalARN parameter must also be specified. <br /><br /> If neither of the PrincipalARN and RoleARN parameters are supplied and the user is authorized to assume multiple roles the cmdlet will prompt to select the role that should be referenced by the profile. The user is also prompted if ARNs are specified but cannot be found in the data returned on successful authentication. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NetworkCredential</name> <description> <para>Optional. Supply a value only if an identity different to the user's default Windows identity should be used during authentication. <br /><br /> If an alternate credential is specified then when the tools need to re-authenticate the user to obtain fresh credentials following expiry the user is prompted to re-enter the password for the user account before re-authentication can be performed. When the default user identity is configured for use (-NetworkCredential not specified) re-authentication occurs silently. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StoreAs</name> <description> <para>The name to associate with the role data. This name will be used with the -ProfileName parameter to Set-AWSCredentials cmdlet and AWS service cmdlets to load the profile and obtain temporary AWS credentials based on the role and other data held in the profile. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>STSEndpointRegion</name> <description> <para>Specifies the region to be used when making calls to STS to obtain temporary credentials after successful authentication. This parameter is only needed in regions where a specific regional endpoint for STS must be used (eg cn-north-1). In all regions where the global sts.amazonaws.com endpoint can be used this parameter should not be specified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Set-AWSSamlRoleProfile</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>EndpointName</name> <description> <para>The name assigned to the endpoint definition that was previously registered using Set-AWSSamlEndpoint. The endpoint definition contains the URL of the endpoint to be used to authenticate users prior to vending temporary AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NetworkCredential</name> <description> <para>Optional. Supply a value only if an identity different to the user's default Windows identity should be used during authentication. <br /><br /> If an alternate credential is specified then when the tools need to re-authenticate the user to obtain fresh credentials following expiry the user is prompted to re-enter the password for the user account before re-authentication can be performed. When the default user identity is configured for use (-NetworkCredential not specified) re-authentication occurs silently. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StoreAllRoles</name> <description> <para>If set all roles available to the user are evaluated following authentication and one role profile per role will be created. The name of each role will be used for each corresponding profile that is created. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>STSEndpointRegion</name> <description> <para>Specifies the region to be used when making calls to STS to obtain temporary credentials after successful authentication. This parameter is only needed in regions where a specific regional endpoint for STS must be used (eg cn-north-1). In all regions where the global sts.amazonaws.com endpoint can be used this parameter should not be specified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>EndpointName</name> <description> <para>The name assigned to the endpoint definition that was previously registered using Set-AWSSamlEndpoint. The endpoint definition contains the URL of the endpoint to be used to authenticate users prior to vending temporary AWS credentials. </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="False" position="Named"> <name>NetworkCredential</name> <description> <para>Optional. Supply a value only if an identity different to the user's default Windows identity should be used during authentication. <br /><br /> If an alternate credential is specified then when the tools need to re-authenticate the user to obtain fresh credentials following expiry the user is prompted to re-enter the password for the user account before re-authentication can be performed. When the default user identity is configured for use (-NetworkCredential not specified) re-authentication occurs silently. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue> <type> <name>System.Management.Automation.PSCredential</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrincipalARN</name> <description> <para>The Amazon Resource Name (ARN) of the principal holding the role to be assumed when credentials are requested following successful authentication. If specified the RoleARN parameter must also be specified. <br /><br /> If neither of the PrincipalARN and RoleARN parameters are supplied and the user is authorized to assume multiple roles the cmdlet will prompt to select the role that should be referenced by the profile. The user is also prompted if ARNs are specified but cannot be found in the data returned on successful authentication. </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="False" position="Named"> <name>RoleARN</name> <description> <para>The Amazon Resource Name (ARN) of the role to be assumed when credentials are requested following successful authentication. If specified the PrincipalARN parameter must also be specified. <br /><br /> If neither of the PrincipalARN and RoleARN parameters are supplied and the user is authorized to assume multiple roles the cmdlet will prompt to select the role that should be referenced by the profile. The user is also prompted if ARNs are specified but cannot be found in the data returned on successful authentication. </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="False" position="Named"> <name>StoreAllRoles</name> <description> <para>If set all roles available to the user are evaluated following authentication and one role profile per role will be created. The name of each role will be used for each corresponding profile that is created. </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="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StoreAs</name> <description> <para>The name to associate with the role data. This name will be used with the -ProfileName parameter to Set-AWSCredentials cmdlet and AWS service cmdlets to load the profile and obtain temporary AWS credentials based on the role and other data held in the profile. </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="False" position="Named"> <name>STSEndpointRegion</name> <description> <para>Specifies the region to be used when making calls to STS to obtain temporary credentials after successful authentication. This parameter is only needed in regions where a specific regional endpoint for STS must be used (eg cn-north-1). In all regions where the global sts.amazonaws.com endpoint can be used this parameter should not be specified. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns the name of the role profile to the pipeline. If the -StoreAllRoles switch is used the names of all created or updated profiles are output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-AWSSamlRoleProfile.html&tocid=Set-AWSSamlRoleProfile</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Set-AWSSamlRoleProfile -StoreAs Role1 -EndpointName MyADFSEndpoint</code><remarks><para>Description</para><para>-----------</para><para>Authenticates the currently logged in user account against the specified endpoint (configured previusly using Set-AWSSamlEndpoint). Following successful authentication, if the user is authorized to assume only a single role the role details are stored in a profile named 'Role1'. If the user is authorized for more than one role a menu is presented for the desired role to be associated with the profile to be selected. The role profile can be used to obtain time-limited temporary AWS credentials by specifying it as the value of the -ProfileName parameter to the Set-AWSCredentials cmdlet or any cmdlet that makes calls to AWS service operations. Authentication prior to obtaining credentials is performed using the current user identity.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> $credential = Get-Credential -Message "Enter user credentials for authentication" PS C:\> Set-AWSSamlRoleProfile -StoreAs Role1 -EndpointName MyADFSEndpoint -NetworkCredential $credential </code><remarks><para>Description</para><para>-----------</para><para>Authenticates the specified user account against the specified endpoint (configured previously using Set-AWSSamlEndpoint). Following successful authentication, if the user is authorized to assume only a single role the role details are stored in a profile named 'Role1'. If the user is authorized for more than one role a menu is presented for the desired role to be associated with the profile to be selected. The role profile can be used to obtain time-limited temporary AWS credentials by specifying it as the value of the -ProfileName parameter to the Set-AWSCredentials cmdlet or any cmdlet that makes calls to AWS service operations. Authentication prior to obtaining credentials is performed using the current user identity.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> PS C:\> $params = @{ "PrincipalARN"="arn:aws:iam::012345678912:saml-provider/ADFS" "RoleARN"="arn:aws:iam::012345678912:role/ADFS-Dev" } PS C:\> Set-AWSSamlRoleProfile @params -StoreAs ADFS-Dev </code><remarks><para>Description</para><para>-----------</para><para>This example shows how to create or update a role profile when the Amazon Resource Names (ARNs) for the role are known in advance. Following authentication for the currently logged in user the cmdlet will verify that the role is present in the set the user is authorized to assume and set up the role profile. If the role is not found the user is prompted to select the correct role. To authenticate as a different user account add the -NetworkCredential parameter as shown in other examples.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\>Set-AWSSamlRoleProfile -StoreAllRoles -EndpointName MyADFSEndpoint</code><remarks><para>Description</para><para>-----------</para><para>Authenticates the current user account against the configured endpoint and if successful creates one role profile for each role the user is authorized to assume. The 'friendly name' of the role is used as the name for each profile. To authenticate as a different user account add the -NetworkCredential parameter as shown in other examples.</para><para /><para /></remarks> </example> </examples> </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>Get-AWSCmdletName</name> <description> <para>Searches for cmdlets that invoke a Amazon Web Services service operation, map to an AWS CLI command, or lists all cmdlets that belong to a service identified by one or more words in its name or its cmdlet noun prefix. If no service name or pattern is given all service cmdlets are output.</para> </description> <verb>Get</verb> <noun>AWSCmdletName</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the name of the cmdlet that invokes a named Amazon Web Services service operation, optionally restricting the scope of the search to a specific service which can be identified using one or more words from the service name or the prefix applied to the nouns of cmdlets belonging to the service. Returns the names and corresponding service operations for a specific Amazon Web Services service which can be identified using one or more words from the service name or the prefix applied to the nouns of cmdlets belonging to the service. Returns the name of the cmdlet that is the equivalent to an AWS CLI command. In this mode a best-effort is made to extract the service and operation name data from the CLI command using known naming conventions and position rules used by the AWS CLI. If no match is made, no data is output. If the service cannot be identified, an error is displayed. </para> </description> <syntax> <syntaxItem> <name>Get-AWSCmdletName</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApiOperation</name> <description> <para>The name of the service operation (api) to search for. If not further restricted by service prefix or service name, all cmdlets across all services are inspected for a matching operation. By default the value supplied for this parameter is treated as a simple whole-word pattern to match. If the -MatchWithRegex switch is set the value is used as a regular expression. In both cases the search is case-insensitive/invariant culture. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MatchWithRegex</name> <description> <para>If set, the value supplied for the ApiOperation parameter is assumed to be a regular expression. By default, the value supplied for ApiOperation is treated as a simple case-insensitive whole-word pattern to match (the cmdlet will surround the ApiOperation value with ^ and $ tokens automatically). If the switch is set no modification of the supplied value is performed. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Service</name> <description> <para>Restricts the search to the cmdlets belonging to services that match the full or partial term supplied to the parameter value, which can be the service prefix (for example 'EC2') or one or more terms from the service name (for example 'compute' or 'compute cloud'). When partial names are used (as opposed to a prefix code) all services for which a match can be found are used to assist in the cmdlet results. A regular expression can always be supplied for the parameter value. If this is the only parameter supplied to the cmdlet, the output will list all of the cmdlets belonging to the services matching the search term, together with the corresponding service operation names. Note that for services with 'helper' cmdlets that do not invoke a particular service operation the ServiceOperation member for the cmdlet in the resulting output is left blank. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Get-AWSCmdletName</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AwsCliCommand</name> <description> <para>The AWS CLI command to match. For example 'aws ec2 describe-instances'. The cmdlet will make a best-effort to identify the owning service and the operation name by parsing the command using known conventions for the AWS CLI command format. The 'aws' prefix may be omitted and any AWS CLI options (identified by the prefix characters --) are skipped when parsing the value to identify the service code and operation name elements. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApiOperation</name> <description> <para>The name of the service operation (api) to search for. If not further restricted by service prefix or service name, all cmdlets across all services are inspected for a matching operation. By default the value supplied for this parameter is treated as a simple whole-word pattern to match. If the -MatchWithRegex switch is set the value is used as a regular expression. In both cases the search is case-insensitive/invariant culture. </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="False" position="Named"> <name>AwsCliCommand</name> <description> <para>The AWS CLI command to match. For example 'aws ec2 describe-instances'. The cmdlet will make a best-effort to identify the owning service and the operation name by parsing the command using known conventions for the AWS CLI command format. The 'aws' prefix may be omitted and any AWS CLI options (identified by the prefix characters --) are skipped when parsing the value to identify the service code and operation name elements. </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="False" position="Named"> <name>MatchWithRegex</name> <description> <para>If set, the value supplied for the ApiOperation parameter is assumed to be a regular expression. By default, the value supplied for ApiOperation is treated as a simple case-insensitive whole-word pattern to match (the cmdlet will surround the ApiOperation value with ^ and $ tokens automatically). If the switch is set no modification of the supplied value is performed. </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="False" position="Named"> <name>Service</name> <description> <para>Restricts the search to the cmdlets belonging to services that match the full or partial term supplied to the parameter value, which can be the service prefix (for example 'EC2') or one or more terms from the service name (for example 'compute' or 'compute cloud'). When partial names are used (as opposed to a prefix code) all services for which a match can be found are used to assist in the cmdlet results. A regular expression can always be supplied for the parameter value. If this is the only parameter supplied to the cmdlet, the output will list all of the cmdlets belonging to the services matching the search term, together with the corresponding service operation names. Note that for services with 'helper' cmdlets that do not invoke a particular service operation the ServiceOperation member for the cmdlet in the resulting output is left blank. </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>PSObject</name> <uri /> <description /> </type> <description> <para>A collection of zero or more objects listing cmdlets that implement the specified operation, map to the AWS CLI command or belong to the specified service.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-AWSCmdletName.html&tocid=Get-AWSCmdletName</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\>Get-AWSCmdletName -ApiOperation describeinstances CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Get-EC2Instance DescribeInstances Amazon Elastic Compute Cloud EC2 Get-OPSInstances DescribeInstances AWS OpsWorks OPS </code><remarks><para>Description</para><para>-----------</para><para>Returns the names of the all cmdlets that invoke an API matching the term 'describeinstances' across all services. In this example, 'Get-EC2Instance' from Amazon EC2 and Get-OPSInstances from Amazon OpsWorks are output.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\>Get-AWSCmdletName -ApiOperation describeinstances -Service ec2 CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Get-EC2Instance DescribeInstances Amazon Elastic Compute Cloud EC2 </code><remarks><para>Description</para><para>-----------</para><para>Returns the names of the all cmdlets that invoke an API matching the term 'describeinstances' for the Amazon EC2 service.In this example, 'Get-EC2Instance' is output.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> PS C:\>Get-AWSCmdletName -ApiOperation describeinstances -Service "compute cloud" CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Get-EC2Instance DescribeInstances Amazon Elastic Compute Cloud EC2 </code><remarks><para>Description</para><para>-----------</para><para>Returns the names of the all cmdlets that invoke an API matching the term 'describeinstances' for the Amazon EC2 service.In this example, 'Get-EC2Instance' is output.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code> PS C:\>Get-AWSCmdletName -ApiOperation securitygroup -MatchWithRegex CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Approve-ECCacheSecurityGroupIngress AuthorizeCacheSecurityGroupIngress Amazon ElastiCache EC Get-ECCacheSecurityGroup DescribeCacheSecurityGroups Amazon ElastiCache EC ... Get-EC2SecurityGroup DescribeSecurityGroups Amazon Elastic Compute Cloud EC2 Grant-EC2SecurityGroupEgress AuthorizeSecurityGroupEgress Amazon Elastic Compute Cloud EC2 Grant-EC2SecurityGroupIngress AuthorizeSecurityGroupIngress Amazon Elastic Compute Cloud EC2 ... New-RDSDBSecurityGroup CreateDBSecurityGroup Amazon Relational Database Service RDS Remove-RDSDBSecurityGroup DeleteDBSecurityGroup Amazon Relational Database Service RDS Revoke-RDSDBSecurityGroupIngress RevokeDBSecurityGroupIngress Amazon Relational Database Service RDS ... Approve-RSClusterSecurityGroupIngress AuthorizeClusterSecurityGroupIngress Amazon Redshift RS Get-RSClusterSecurityGroups DescribeClusterSecurityGroups Amazon Redshift RS </code><remarks><para>Description</para><para>-----------</para><para>Returns the names of the all cmdlets that contain the term 'securitygroup' in the operation they invoke, across all services.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code> PS C:\>Get-AWSCmdletName -ApiOperation securitygroup -MatchWithRegex -Service ec2 CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Get-EC2SecurityGroup DescribeSecurityGroups Amazon Elastic Compute Cloud EC2 Grant-EC2SecurityGroupEgress AuthorizeSecurityGroupEgress Amazon Elastic Compute Cloud EC2 Grant-EC2SecurityGroupIngress AuthorizeSecurityGroupIngress Amazon Elastic Compute Cloud EC2 ... </code><remarks><para>Description</para><para>-----------</para><para>Returns the names of the all Amazon EC2 cmdlets that contain the term 'securitygroup' in the operation they invoke.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 6 --------------------------</title><code> PS C:\>Get-AWSCmdletName -ApiOperation listmetrics -Service cloudwatch CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Get-CWMetrics ListMetrics Amazon CloudWatch CW </code><remarks><para>Description</para><para>-----------</para><para>Returns the name of the cmdlet that invokes the Amazon CloudWatch 'ListMetrics' operation. In this example, 'Get-CWMetrics' is output. The same result can be obtained by using the service prefix, 'cw' as the value for the -Service parameter.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 7 --------------------------</title><code> PS C:\>Get-AWSCmdletName -AwsCliCommand "aws ec2 describe-images" CmdletName ServiceOperation ServiceName CmdletNounPrefix ---------- ---------------- ----------- ---------------- Get-EC2Image DescribeImages Amazon Elastic Compute Cloud EC2 </code><remarks><para>Description</para><para>-----------</para><para>Returns the name of the cmdlet that performs the same operation as the specified AWS CLI command. In this example, 'Get-EC2Image' is output. Any options (prefixed by --) in the AWS CLI command are ignored. The initial 'aws' can also be omitted. This format is useful when transcoding an AWS CLI sample to AWS PowerShell.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 8 --------------------------</title><code> PS C:\> Get-AWSCmdletName -Service ec2 CmdletName ServiceOperation ServiceName ---------- ---------------- ----------- Add-EC2ClassicLinkVpc AttachClassicLinkVpc Amazon Elastic Compute Cloud Add-EC2InternetGateway AttachInternetGateway Amazon Elastic Compute Cloud Add-EC2NetworkInterface AttachNetworkInterface Amazon Elastic Compute Cloud ... Get-ECSClusterDetail DescribeClusters Amazon EC2 Container Service Get-ECSClusters ListClusters Amazon EC2 Container Service Get-ECSClusterService ListServices Amazon EC2 Container Service ... </code><remarks><para>Description</para><para>-----------</para><para>Performs a search to list all cmdlets that have 'ec2' in either the service name or the cmdlet noun prefix. In this example this matches Amazon Elastic Compute Cloud (search term matches noun prefix) and Amazon EC2 Container Service (search term found in the name).</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 9 --------------------------</title><code> PS C:\> Get-AWSCmdletName -Service compute CmdletName ServiceOperation ServiceName ---------- ---------------- ----------- Add-EC2ClassicLinkVpc AttachClassicLinkVpc Amazon Elastic Compute Cloud Add-EC2InternetGateway AttachInternetGateway Amazon Elastic Compute Cloud Add-EC2NetworkInterface AttachNetworkInterface Amazon Elastic Compute Cloud ... Unregister-EC2Image DeregisterImage Amazon Elastic Compute Cloud Unregister-EC2PrivateIpAddress UnassignPrivateIpAddresses Amazon Elastic Compute Cloud Unregister-EC2RouteTable DisassociateRouteTable Amazon Elastic Compute Cloud </code><remarks><para>Description</para><para>-----------</para><para>Performs a search to list all cmdlets that have 'compute' in either the service name or the cmdlet noun prefix. In this example the match is for Amazon Elastic Compute Cloud only (search term found in the name).</para><para /><para /></remarks> </example> </examples> </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>Add-AWSLoggingListener</name> <description> <para>Adds a listener to aws service calls and enable logging.</para> </description> <verb>Add</verb> <noun>AWSLoggingListener</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds a single trace listener to the specified trace source. Given a name and file path, creates a TextWriterTraceListener with the given name and file path, and adds it to the listeners for the trace source. If Source is not specified, 'Amazon' is assumed, which represents all SDK API calls. In the case where there are multiple listeners for multiple sources, Trace calls for an API will go to the most specific source only. For example, if one listener is added to 'Amazon.S3' and another on 'Amazon', then S3 calls will only be logged to the former listener. </para> </description> <syntax> <syntaxItem> <name>Add-AWSLoggingListener</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="1"> <name>Name</name> <description> <para>The name of the logger. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>LogFilePath</name> <description> <para>File path to write the log to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Source</name> <description> <para>Specify a source to log responses for. Defaults to all responses (i.e. 'Amazon'). To limit to a specific service (for example DynamoDB), use 'Amazon.DynamoDB'.) </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Add-AWSLoggingListener</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="1"> <name>TraceListener</name> <description> <para>Specify a custom trace listener object. </para> </description> <parameterValue required="true" variableLength="false">System.Diagnostics.TraceListener</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Source</name> <description> <para>Specify a source to log responses for. Defaults to all responses (i.e. 'Amazon'). To limit to a specific service (for example DynamoDB), use 'Amazon.DynamoDB'.) </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>LogFilePath</name> <description> <para>File path to write the log to. </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="False" position="1"> <name>Name</name> <description> <para>The name of the logger. </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="False" position="Named"> <name>Source</name> <description> <para>Specify a source to log responses for. Defaults to all responses (i.e. 'Amazon'). To limit to a specific service (for example DynamoDB), use 'Amazon.DynamoDB'.) </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="False" position="1"> <name>TraceListener</name> <description> <para>Specify a custom trace listener object. </para> </description> <parameterValue required="true" variableLength="false">System.Diagnostics.TraceListener</parameterValue> <type> <name>System.Diagnostics.TraceListener</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not produce any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Add-AWSLoggingListener.html&tocid=Add-AWSLoggingListener</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Add-AWSLoggingListener -Name MyAWSLogs -LogFilePath c:\logs\aws.txt</code><remarks><para>Description</para><para>-----------</para><para>Attaches a listener for the source 'Amazon', matching responses from all services for the current script or shell. Log output will be written to the specified file (the folder path must exist). Multiple listeners for different namespaces can be active at a time. By default only error responses are logged.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Add-AWSLoggingListener -Name MyS3Logs -LogFilePath c:\logs\s3.txt -Source Amazon.S3</code><remarks><para>Description</para><para>-----------</para><para>Attaches a listener for the source 'Amazon.S3'. Responses matching only this namespace will be logged to the specified file (the folder path must exist). Multiple listeners for different namespaces can be active at a time. By default only error responses are logged.</para><para /><para /></remarks> </example> </examples> </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-AWSLoggingListener</name> <description> <para>Removes a logger from the specified source (e.g. 'Amazon', or 'Amazon.S3') by name.</para> </description> <verb>Remove</verb> <noun>AWSLoggingListener</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Remove a listener from and AWS API trace source. </para> </description> <syntax> <syntaxItem> <name>Remove-AWSLoggingListener</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="1"> <name>Source</name> <description> <para>Source to remove the listener from. Examples: 'Amazon', or 'Amazon.DynamoDB'. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Name</name> <description> <para>Name of the trace listener to remove. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Name</name> <description> <para>Name of the trace listener to remove. </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="False" position="1"> <name>Source</name> <description> <para>Source to remove the listener from. Examples: 'Amazon', or 'Amazon.DynamoDB'. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not produce any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-AWSLoggingListener.html&tocid=Remove-AWSLoggingListener</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-AWSLoggingListener -Source Amazon.S3 -Name MyS3Logs</code><remarks><para>Description</para><para>-----------</para><para>Removes the specified logger from the trace source.</para><para /><para /></remarks> </example> </examples> </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>Set-AWSResponseLogging</name> <description> <para>Modify response logging options for AWS service requests.</para> </description> <verb>Set</verb> <noun>AWSResponseLogging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modify when to produce log entries. </para> </description> <syntax> <syntaxItem> <name>Set-AWSResponseLogging</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="1"> <name>Level</name> <description> <para>When to log responses. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="1"> <name>Level</name> <description> <para>When to log responses. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not produce any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-AWSResponseLogging.html&tocid=Set-AWSResponseLogging</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Set-AWSResponseLogging -Level Always</code><remarks><para>Description</para><para>-----------</para><para>Enables logging of all service responses configured in the attached listeners. Other values for the -Level parameter are 'Never', which turns off logging and 'OnError' which logs only error responses.</para><para /><para /></remarks> </example> </examples> </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>Enable-AWSMetricsLogging</name> <description> <para>Enable logging of metrics data for AWS service requests.</para> </description> <verb>Enable</verb> <noun>AWSMetricsLogging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Amazon.PowerShell.Common.EnableMetricsLoggingCmdlet </para> </description> <syntax> <syntaxItem> <name>Enable-AWSMetricsLogging</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not produce any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Enable-AWSMetricsLogging.html&tocid=Enable-AWSMetricsLogging</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Enable-AWSMetricsLogging</code><remarks><para>Description</para><para>-----------</para><para>Turns on logging of performance metrics for service calls.</para><para /><para /></remarks> </example> </examples> </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>Disable-AWSMetricsLogging</name> <description> <para>Disable logging of metrics data for AWS service requests.</para> </description> <verb>Disable</verb> <noun>AWSMetricsLogging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Amazon.PowerShell.Common.DisableMetricsLoggingCmdlet </para> </description> <syntax> <syntaxItem> <name>Disable-AWSMetricsLogging</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not produce any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Disable-AWSMetricsLogging.html&tocid=Disable-AWSMetricsLogging</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Disable-AWSMetricsLogging</code><remarks><para>Description</para><para>-----------</para><para>Turns off logging of performance metrics for service calls.</para><para /><para /></remarks> </example> </examples> </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>Set-AWSProxy</name> <description> <para>Sets AWS default proxy for the shell. Subsequent AWS cmdlet invocations will use the configured proxy.</para> </description> <verb>Set</verb> <noun>AWSProxy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets AWS default proxy for the shell. </para> </description> <syntax> <syntaxItem> <name>Set-AWSProxy</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="1"> <name>Hostname</name> <description> <para>Proxy server host </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Port</name> <description> <para>Proxy server port </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Username</name> <description> <para>Username to submit to the proxy server for authentication </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Password</name> <description> <para>Password to submit to the proxy server for authentication </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>Credential</name> <description> <para>The credentials to submit to the proxy server for authentication </para> </description> <parameterValue required="true" variableLength="false">System.Net.ICredentials</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BypassList</name> <description> <para>An array of regular expressions that describe URIs that do not use the proxy server when accessed. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BypassOnLocal</name> <description> <para>If specified, requests to local Internet resources do not use the configured proxy. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BypassList</name> <description> <para>An array of regular expressions that describe URIs that do not use the proxy server when accessed. </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="False" position="Named"> <name>BypassOnLocal</name> <description> <para>If specified, requests to local Internet resources do not use the configured proxy. </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="False" position="5"> <name>Credential</name> <description> <para>The credentials to submit to the proxy server for authentication </para> </description> <parameterValue required="true" variableLength="false">System.Net.ICredentials</parameterValue> <type> <name>System.Net.ICredentials</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="1"> <name>Hostname</name> <description> <para>Proxy server host </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="False" position="4"> <name>Password</name> <description> <para>Password to submit to the proxy server for authentication </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="False" position="2"> <name>Port</name> <description> <para>Proxy server port </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Username</name> <description> <para>Username to submit to the proxy server for authentication </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-AWSProxy.html&tocid=Set-AWSProxy</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Set-AWSProxy -Hostname localhost -Port 8888</code><remarks><para>Description</para><para>-----------</para><para>This command configures a proxy that does not require special credentials.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Set-AWSProxy -Hostname localhost -Port 8888 -Username 1 -Password 1</code><remarks><para>Description</para><para>-----------</para><para>This command configures a proxy that requires a username and a password.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Set-AWSProxy -Hostname localhost -Port 8888 -Credential ([System.Net.CredentialCache]::DefaultCredentials)</code><remarks><para>Description</para><para>-----------</para><para>This command configures a proxy with default credentials. The -Credentials parameter can be used for any credentials object that implements the ICredentials interface.</para><para /><para /></remarks> </example> </examples> </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>Clear-AWSProxy</name> <description> <para>Clears AWS default proxy for the shell. Subsequent AWS cmdlet invocations will not use a proxy.</para> </description> <verb>Clear</verb> <noun>AWSProxy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Clears AWS default proxy for the shell. </para> </description> <syntax> <syntaxItem> <name>Clear-AWSProxy</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Clear-AWSProxy.html&tocid=Clear-AWSProxy</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Clear-AWSProxy</code><remarks><para>Description</para><para>-----------</para><para>This command removes proxy configuration from the current shell. Subsequent cmdlets invocations will not use a proxy.</para><para /><para /></remarks> </example> </examples> </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>Get-AWSPublicIpAddressRange</name> <description> <para>Returns the public IP address range data for Amazon Web Services. Each address range instance contains the service key, host region and IP address range (in CIDR notation).</para> </description> <verb>Get</verb> <noun>AWSPublicIpAddressRange</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the collection of current public IP address ranges for Amazon Web Services. Each address range instance contains the service key, host region and IP address range (in CIDR notation). The cmdlet can optionally emit the set of currently known service keys, perform filtering of output by service key or region information or output the publication date and time of the current information. The information processed by this cmdlet is contained in a publicly accessible JSON-format file at https://ip-ranges.amazonaws.com/ip-ranges.json. The information in this file is generated from our internal system-of-record and is authoritative. You can expect it to change several times per week and should poll accordingly For more details on the public IP address range data for Amazon Web Services, see http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html. </para> </description> <syntax> <syntaxItem> <name>Get-AWSPublicIpAddressRange</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceKey</name> <description> <para>If set, contains one or more service keys to filter the output to. This parameter can be used in conjunction with the Region parameter to filter by region and service key. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Region</name> <description> <para>If set, contains one or more region identifiers (e.g. "us-east-1", "global") to filter the output to. This parameter can be used in conjunction with the ServiceKey parameter to filter by region and service key. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Get-AWSPublicIpAddressRange</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputServiceKeys</name> <description> <para>If set the cmdlet emits the collection of currently-known service keys used in the address range data. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Get-AWSPublicIpAddressRange</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputPublicationDate</name> <description> <para>If set the cmdlet emits the publication date and time of the data. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputPublicationDate</name> <description> <para>If set the cmdlet emits the publication date and time of the data. </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="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputServiceKeys</name> <description> <para>If set the cmdlet emits the collection of currently-known service keys used in the address range data. </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="False" position="Named"> <name>Region</name> <description> <para>If set, contains one or more region identifiers (e.g. "us-east-1", "global") to filter the output to. This parameter can be used in conjunction with the ServiceKey parameter to filter by region and service key. </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="False" position="Named"> <name>ServiceKey</name> <description> <para>If set, contains one or more service keys to filter the output to. This parameter can be used in conjunction with the Region parameter to filter by region and service key. </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>AWSPublicIpAddressRange</name> <uri /> <description /> </type> <description> <para>A collection of AWSPublicIpAddressRange instances. This is the default output from the cmdlet.</para> </description> </returnValue> <returnValue> <type> <name>String[]</name> <uri /> <description /> </type> <description> <para>A collection of currently-known service keys used in the address data, if the -OutputServiceKeys switch is set.</para> </description> </returnValue> <returnValue> <type> <name>DateTime</name> <uri /> <description /> </type> <description> <para>The publication date and time if the -OutputPublicationDate switch is set.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-AWSPublicIpAddressRange.html&tocid=Get-AWSPublicIpAddressRange</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\>Get-AWSPublicIpAddressRange IpPrefix Region Service -------- ------ ------- 50.19.0.0/16 us-east-1 AMAZON 54.239.98.0/24 us-east-1 AMAZON ... 50.19.0.0/16 us-east-1 EC2 75.101.128.0/17 us-east-1 EC2 ... 205.251.192.0/21 GLOBAL ROUTE53 54.232.40.64/26 sa-east-1 ROUTE53_HEALTHCHECKS ... 54.239.192.0/19 GLOBAL CLOUDFRONT 204.246.176.0/20 GLOBAL CLOUDFRONT ... </code><remarks><para>Description</para><para>-----------</para><para>Outputs all of the current IP address range objects to the pipeline.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\>Get-AWSPublicIpAddressRange -OutputServiceKeys AMAZON EC2 ROUTE53 ROUTE53_HEALTHCHECKS CLOUDFRONT </code><remarks><para>Description</para><para>-----------</para><para>Outputs the currently used set of 'Service' keys to the pipeline.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> PS C:\>Get-AWSPublicIpAddressRange -OutputPublicationDate Monday, December 15, 2014 4:41:01 PM </code><remarks><para>Description</para><para>-----------</para><para>Outputs the publication date of the IP address range information.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\>Get-AWSPublicIpAddressRange -ServiceKey ec2</code><remarks><para>Description</para><para>-----------</para><para>Filters the IP address ranges to output only those with a 'Service' value of 'EC2' to the pipeline.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code>PS C:\>Get-AWSPublicIpAddressRange -Region us-west-2</code><remarks><para>Description</para><para>-----------</para><para>Filters the IP address ranges to output only those used in the US West (Oregon) region to the pipeline.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 6 --------------------------</title><code>PS C:\>Get-AWSPublicIpAddressRange -ServiceKey ec2,route53_healthchecks -Region us-west-2</code><remarks><para>Description</para><para>-----------</para><para>Filters the IP address ranges to output only those belonging to EC2 and CloudFront and in the US West (Oregon) region to the pipeline. Multiple values can also be specified for the -Region parameter.</para><para /><para /></remarks> </example> </examples> </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>Set-DefaultAWSRegion</name> <description> <para>Sets a default AWS region system name (e.g. us-west-2, eu-west-1 etc) into the shell variable $StoredAWSRegion. AWS cmdlets will use the value of this variable to satisfy their -Region parameter if the parameter is not specified.</para> </description> <verb>Set</verb> <noun>DefaultAWSRegion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets a default AWS region into the shell environment, accessible as $StoredAWSRegion. </para> </description> <syntax> <syntaxItem> <name>Set-DefaultAWSRegion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="211"> <name>Region</name> <description> <para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. If the Region parameter is supplied the cmdlet ignores the ProfileLocation parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Object</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="212"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs). When supplied the cmdlet will attempt to read the default region to be used from the credential file's default profile. If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="212"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs). When supplied the cmdlet will attempt to read the default region to be used from the credential file's default profile. If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </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 (ByValue, ByPropertyName)" position="211"> <name>Region</name> <description> <para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. If the Region parameter is supplied the cmdlet ignores the ProfileLocation parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Object</parameterValue> <type> <name>System.Object</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-DefaultAWSRegion.html&tocid=Set-DefaultAWSRegion</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> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Set-DefaultAWSRegion -Region us-west-2</code><remarks><para>Description</para><para>-----------</para><para>Sets the default region for all cmdlets in the current shell to 'us-west-2' (the parameter name can be omitted for brevity). Once a shell default has been set you can override the default by using the -Region parameter with the specific cmdlet(s) as required.</para><para /><para /></remarks> </example> </examples> </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>Clear-DefaultAWSRegion</name> <description> <para>Clears any default AWS region set in the shell variable $StoredAWSRegion.</para> </description> <verb>Clear</verb> <noun>DefaultAWSRegion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Clears any default AWS region set in the shell variable $StoredAWSRegion. </para> </description> <syntax> <syntaxItem> <name>Clear-DefaultAWSRegion</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Clear-DefaultAWSRegion.html&tocid=Clear-DefaultAWSRegion</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>Get-DefaultAWSRegion</name> <description> <para>Returns the current default AWS region for this shell, if any, as held in the shell variable $StoredAWSRegion.</para> </description> <verb>Get</verb> <noun>DefaultAWSRegion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the current default AWS region for this shell, if any, as held in the shell variable $StoredAWSRegion. </para> </description> <syntax> <syntaxItem> <name>Get-DefaultAWSRegion</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>AWSRegion</name> <uri /> <description /> </type> <description> <para>AWSRegion instance mapping to the default AWS region stored in $StoredAWSRegion.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-DefaultAWSRegion.html&tocid=Get-DefaultAWSRegion</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>Get-AWSRegion</name> <description> <para>Returns the set of available AWS regions.</para> </description> <verb>Get</verb> <noun>AWSRegion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the set of available AWS regions. </para> </description> <syntax> <syntaxItem> <name>Get-AWSRegion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SystemName</name> <description> <para>If set returns an AWSRegion instance corresponding to the specified system name (e.g. us-west-2). This parameter can also be used to return AWSRegion instances for the US GovCloud and China (Beijing) regions by specifying the relevant system name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeChina</name> <description> <para>Include the China (Beijing) region in the returned collection of AWSRegion instances. Note that use of this region requires an alternate set of credentials. This switch is ignored if the SystemName parameter is used to request a specific AWSRegion instance. To return the specific China (Beijing) region, specify a value of 'cn-north-1' for the SystemName parameter. Default: off. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Get-AWSRegion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SystemName</name> <description> <para>If set returns an AWSRegion instance corresponding to the specified system name (e.g. us-west-2). This parameter can also be used to return AWSRegion instances for the US GovCloud and China (Beijing) regions by specifying the relevant system name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeChina</name> <description> <para>Include the China (Beijing) region in the returned collection of AWSRegion instances. Note that use of this region requires an alternate set of credentials. This switch is ignored if the SystemName parameter is used to request a specific AWSRegion instance. To return the specific China (Beijing) region, specify a value of 'cn-north-1' for the SystemName parameter. Default: off. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeGovCloud</name> <description> <para>If set the returned collection includes 'Gov Cloud' region(s). Default: off. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Get-AWSRegion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GovCloudOnly</name> <description> <para>If set the returned collection contains only the 'Gov Cloud' region(s). Default: off. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GovCloudOnly</name> <description> <para>If set the returned collection contains only the 'Gov Cloud' region(s). Default: off. </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="False" position="Named"> <name>IncludeChina</name> <description> <para>Include the China (Beijing) region in the returned collection of AWSRegion instances. Note that use of this region requires an alternate set of credentials. This switch is ignored if the SystemName parameter is used to request a specific AWSRegion instance. To return the specific China (Beijing) region, specify a value of 'cn-north-1' for the SystemName parameter. Default: off. </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="False" position="Named"> <name>IncludeGovCloud</name> <description> <para>If set the returned collection includes 'Gov Cloud' region(s). Default: off. </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 (ByValue, )" position="1"> <name>SystemName</name> <description> <para>If set returns an AWSRegion instance corresponding to the specified system name (e.g. us-west-2). This parameter can also be used to return AWSRegion instances for the US GovCloud and China (Beijing) regions by specifying the relevant system name. </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>AWSRegion</name> <uri /> <description /> </type> <description> <para>AWSRegion instance for each available region.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-AWSRegion.html&tocid=Get-AWSRegion</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-AWSCredentialProfile</name> <description> <para>Removes the credential profile with the supplied name from one of the local credential stores.</para> </description> <verb>Remove</verb> <noun>AWSCredentialProfile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Amazon.PowerShell.Common.RemoveAWSCredentialProfileCmdlet </para> </description> <syntax> <syntaxItem> <name>Remove-AWSCredentialProfile</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ProfileName</name> <description> <para>The name associated with the credential profile that is to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>Suppresses prompts for confirmation before proceeding to remove the specified credential profile. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>Suppresses prompts for confirmation before proceeding to remove the specified credential profile. </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="False" position="3"> <name>ProfileLocation</name> <description> <para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </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="False" position="2"> <name>ProfileName</name> <description> <para>The name associated with the credential profile that is to be deleted. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-AWSCredentialProfile.html&tocid=Remove-AWSCredentialProfile</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>Get-XRServiceGraph</name> <description> <para>Invokes the GetServiceGraph operation against AWS X-Ray.</para> </description> <verb>Get</verb> <noun>XRServiceGraph</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases. </para> </description> <syntax> <syntaxItem> <name>Get-XRServiceGraph</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>StartTime</name> <description> <para>The start of the time frame for which to generate a graph. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The end of the time frame for which to generate a graph. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token. Not used. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The end of the time frame for which to generate a graph. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token. Not used. </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 (ByValue, )" position="1"> <name>StartTime</name> <description> <para>The start of the time frame for which to generate a graph. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.XRay.Model.GetServiceGraphResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.XRay.Model.GetServiceGraphResponse 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-XRServiceGraph.html&tocid=Get-XRServiceGraph</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>Get-XRTraceBatch</name> <description> <para>Invokes the BatchGetTraces operation against AWS X-Ray.</para> </description> <verb>Get</verb> <noun>XRTraceBatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use <code>GetTraceSummaries</code> to get a list of trace IDs. </para> </description> <syntax> <syntaxItem> <name>Get-XRTraceBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TraceId</name> <description> <para>Specify the trace IDs of requests for which to retrieve segments. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token. Not used. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token. Not used. </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="False" position="Named"> <name>TraceId</name> <description> <para>Specify the trace IDs of requests for which to retrieve segments. </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.XRay.Model.BatchGetTracesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.XRay.Model.BatchGetTracesResponse 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-XRTraceBatch.html&tocid=Get-XRTraceBatch</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>Get-XRTraceGraph</name> <description> <para>Invokes the GetTraceGraph operation against AWS X-Ray.</para> </description> <verb>Get</verb> <noun>XRTraceGraph</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a service graph for one or more specific trace IDs. </para> </description> <syntax> <syntaxItem> <name>Get-XRTraceGraph</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TraceId</name> <description> <para>Trace IDs of requests for which to generate a service graph. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token. Not used. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token. Not used. </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="False" position="Named"> <name>TraceId</name> <description> <para>Trace IDs of requests for which to generate a service graph. </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.XRay.Model.Service</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Service objects. The service call response (type Amazon.XRay.Model.GetTraceGraphResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-XRTraceGraph.html&tocid=Get-XRTraceGraph</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>Get-XRTraceSummary</name> <description> <para>Invokes the GetTraceSummaries operation against AWS X-Ray.</para> </description> <verb>Get</verb> <noun>XRTraceSummary</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to <code>BatchGetTraces</code>. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through <code>api.example.com</code>: <code>service("api.example.com")</code> This filter expression finds traces that have an annotation named <code>account</code> with the value <code>12345</code>: <code>annotation.account = "12345"</code> For a full list of indexed fields and keywords that you can use in filter expressions, see <a href="http://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html">Using Filter Expressions</a> in the <i>AWS X-Ray Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-XRTraceSummary</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>StartTime</name> <description> <para>The start of the time frame for which to retrieve traces. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The end of the time frame for which to retrieve traces. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FilterExpression</name> <description> <para>Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Sampling</name> <description> <para>Set to <code>true</code> to get summaries for only a subset of available traces. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Specify the pagination token returned by a previous request to retrieve the next page of results. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The end of the time frame for which to retrieve traces. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FilterExpression</name> <description> <para>Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements. </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="False" position="Named"> <name>NextToken</name> <description> <para>Specify the pagination token returned by a previous request to retrieve the next page of results. </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="False" position="Named"> <name>Sampling</name> <description> <para>Set to <code>true</code> to get summaries for only a subset of available traces. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>StartTime</name> <description> <para>The start of the time frame for which to retrieve traces. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.XRay.Model.GetTraceSummariesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.XRay.Model.GetTraceSummariesResponse 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-XRTraceSummary.html&tocid=Get-XRTraceSummary</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>Write-XRTelemetryRecord</name> <description> <para>Invokes the PutTelemetryRecords operation against AWS X-Ray.</para> </description> <verb>Write</verb> <noun>XRTelemetryRecord</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used by the AWS X-Ray daemon to upload telemetry. </para> </description> <syntax> <syntaxItem> <name>Write-XRTelemetryRecord</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>EC2InstanceId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hostname</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TelemetryRecord</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.XRay.Model.TelemetryRecord[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EC2InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>EC2InstanceId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>Hostname</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EC2InstanceId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ResourceARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>TelemetryRecord</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.XRay.Model.TelemetryRecord[]</parameterValue> <type> <name>Amazon.XRay.Model.TelemetryRecord[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the EC2InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.XRay.Model.PutTelemetryRecordsResponse) 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=Write-XRTelemetryRecord.html&tocid=Write-XRTelemetryRecord</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>Write-XRTraceSegment</name> <description> <para>Invokes the PutTraceSegments operation against AWS X-Ray.</para> </description> <verb>Write</verb> <noun>XRTraceSegment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Amazon.XRay.IAmazonXRay.PutTraceSegments </para> </description> <syntax> <syntaxItem> <name>Write-XRTraceSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TraceSegmentDocument</name> <description> <para>A string containing a JSON document defining one or more segments or subsegments. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>TraceSegmentDocument</name> <description> <para>A string containing a JSON document defining one or more segments or subsegments. </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.XRay.Model.UnprocessedTraceSegment</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of UnprocessedTraceSegment objects. The service call response (type Amazon.XRay.Model.PutTraceSegmentsResponse) 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=Write-XRTraceSegment.html&tocid=Write-XRTraceSegment</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-WKSWorkspace</name> <description> <para>Invokes the TerminateWorkspaces operation against Amazon WorkSpaces.</para> </description> <verb>Remove</verb> <noun>WKSWorkspace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Terminates the specified WorkSpaces. You can specify the Workspaces using either the <code>-WorkspaceId</code> or <code>-Request</code> parameters. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services <b>before</b> terminating the WorkSpace. You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>. This operation is asynchronous and returns before the WorkSpaces have been completely terminated. </para> </description> <syntax> <syntaxItem> <name>Remove-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>An array of TerminateRequest objects specifying the WorkSpaces to be terminated. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.TerminateRequest[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <syntaxItem> <name>Remove-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to terminate. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>An array of TerminateRequest objects specifying the WorkSpaces to be terminated. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.TerminateRequest[]</parameterValue> <type> <name>Amazon.WorkSpaces.Model.TerminateRequest[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to terminate. </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.WorkSpaces.Model.FailedWorkspaceChangeRequest</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of FailedWorkspaceChangeRequest objects. The service call response (type Amazon.WorkSpaces.Model.TerminateWorkspacesResponse) 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=Remove-WKSWorkspace.html&tocid=Remove-WKSWorkspace</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force</code><remarks><para>Description</para><para>-----------</para><para>Terminates multiple WorkSpaces. use of the -Force switch stops the cmdlet from prompting for confirmation.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-WKSWorkspaces | Remove-WKSWorkspace</code><remarks><para>Description</para><para>-----------</para><para>Retrieves the collection of all your WorkSpaces and pipes the IDs to the -WorkSpaceId parameter of Remove-WKSWorkspace, terminating all of the WorkSpaces. The cmdlet will prompt before each WorkSpace is terminated. To suppress the confirmation prompt add the -Force switch.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> $arrRequest = @() $request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest $request1.WorkspaceId = 'ws-12345678' $arrRequest += $request1 $request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest $request2.WorkspaceId = 'ws-abcdefgh' $arrRequest += $request2 Remove-WKSWorkspace -Request $arrRequest </code><remarks><para>Description</para><para>-----------</para><para>This example shows how to pass TerminateRequest objects defining the WorkSpaces to be terminated. The cmdlet will prompt for confirmation before proceeding, unless the -Force switch parameter is also specified.</para><para /><para /></remarks> </example> </examples> </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>Reset-WKSWorkspace</name> <description> <para>Invokes the RebuildWorkspaces operation against Amazon WorkSpaces.</para> </description> <verb>Reset</verb> <noun>WKSWorkspace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Rebuilds the specified WorkSpaces. You can specify the Workspaces using either the <code>-WorkspaceId</code> or <code>-Request</code> parameters. Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur: - The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost. - The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old. To be able to rebuild a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code> or <code>ERROR</code>. This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. </para> </description> <syntax> <syntaxItem> <name>Reset-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>An array of structures that specify the WorkSpaces to rebuild. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.RebuildRequest[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <syntaxItem> <name>Reset-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to rebuild. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>An array of structures that specify the WorkSpaces to rebuild. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.RebuildRequest[]</parameterValue> <type> <name>Amazon.WorkSpaces.Model.RebuildRequest[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to rebuild. </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.WorkSpaces.Model.FailedWorkspaceChangeRequest</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of FailedWorkspaceChangeRequest objects. The service call response (type Amazon.WorkSpaces.Model.RebuildWorkspacesResponse) 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=Reset-WKSWorkspace.html&tocid=Reset-WKSWorkspace</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"</code><remarks><para>Description</para><para>-----------</para><para>Rebuilds the specified WorkSpace.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d",ws-5a6b7c8d"</code><remarks><para>Description</para><para>-----------</para><para>Rebuild the specified WorkSpaces.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Get-WKSWorkspaces | Reset-WKSWorkspace</code><remarks><para>Description</para><para>-----------</para><para>Retrieves the collection of all your WorkSpaces and pipes the IDs to the -WorkSpaceId parameter of Reset-WKSWorkspace, causing the WorkSpaces to be rebuilt.</para><para /><para /></remarks> </example> </examples> </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>Restart-WKSWorkspace</name> <description> <para>Invokes the RebootWorkspaces operation against Amazon WorkSpaces.</para> </description> <verb>Restart</verb> <noun>WKSWorkspace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Reboots the specified WorkSpaces. You can specify the Workspaces using either the <code>-WorkspaceId</code> or <code>-Request</code> parameters. To be able to reboot a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code>, <code>IMPAIRED</code>, or <code>INOPERABLE</code>. This operation is asynchronous and returns before the WorkSpaces have rebooted. </para> </description> <syntax> <syntaxItem> <name>Restart-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>An array of structures that specify the WorkSpaces to reboot. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.RebootRequest[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <syntaxItem> <name>Restart-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to reboot. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>An array of structures that specify the WorkSpaces to reboot. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.RebootRequest[]</parameterValue> <type> <name>Amazon.WorkSpaces.Model.RebootRequest[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to reboot. </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.WorkSpaces.Model.FailedWorkspaceChangeRequest</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of FailedWorkspaceChangeRequest objects. The service call response (type Amazon.WorkSpaces.Model.RebootWorkspacesResponse) 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=Restart-WKSWorkspace.html&tocid=Restart-WKSWorkspace</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"</code><remarks><para>Description</para><para>-----------</para><para>Reboots the specified WorkSpace.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"</code><remarks><para>Description</para><para>-----------</para><para>Reboots multiple WorkSpaces.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Get-WKSWorkspaces | Restart-WKSWorkspace</code><remarks><para>Description</para><para>-----------</para><para>Retrieves the collection of all your WorkSpaces and pipes the IDs to the -WorkSpaceId parameter of Restart-WKSWorkspace, causing the WorkSpaces to be restarted.</para><para /><para /></remarks> </example> </examples> </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>Start-WKSWorkspace</name> <description> <para>Invokes the StartWorkspaces operation against Amazon WorkSpaces.</para> </description> <verb>Start</verb> <noun>WKSWorkspace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Starts the specified WorkSpaces. You can specify the Workspaces using either the <code>-WorkspaceId</code> or <code>-Request</code> parameters. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.” </para> </description> <syntax> <syntaxItem> <name>Start-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>The requests. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.StartRequest[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <syntaxItem> <name>Start-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to start. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>The requests. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.StartRequest[]</parameterValue> <type> <name>Amazon.WorkSpaces.Model.StartRequest[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to start. </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.WorkSpaces.Model.FailedWorkspaceChangeRequest</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of FailedWorkspaceChangeRequest objects. The service call response (type Amazon.WorkSpaces.Model.StartWorkspacesResponse) 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=Start-WKSWorkspace.html&tocid=Start-WKSWorkspace</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</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>Stop-WKSWorkspace</name> <description> <para>Invokes the StopWorkspaces operation against Amazon WorkSpaces.</para> </description> <verb>Stop</verb> <noun>WKSWorkspace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Stops the specified WorkSpaces. You can specify the Workspaces using either the <code>-WorkspaceId</code> or <code>-Request</code> parameters. To terminate WorkSpaces please update your script to use the <code>Remove-WKSWorkspace</code> cmdlet. </para> </description> <syntax> <syntaxItem> <name>Stop-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>An array of StopRequest objects specifying the WorkSpaces to operate on. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.StopRequest[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <syntaxItem> <name>Stop-WKSWorkspace</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to be stopped. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Request</name> <description> <para>An array of StopRequest objects specifying the WorkSpaces to operate on. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.StopRequest[]</parameterValue> <type> <name>Amazon.WorkSpaces.Model.StopRequest[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WorkspaceId</name> <description> <para>The IDs of one or more WorkSpaces to be stopped. </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.WorkSpaces.Model.FailedWorkspaceChangeRequest</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of FailedWorkspaceChangeRequest objects. The service call response (type Amazon.WorkSpaces.Model.StopWorkspacesResponse) 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=Stop-WKSWorkspace.html&tocid=Stop-WKSWorkspace</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"</code><remarks><para>Description</para><para>-----------</para><para>Stops multiple WorkSpaces.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-WKSWorkspaces | Stop-WKSWorkspace</code><remarks><para>Description</para><para>-----------</para><para>Retrieves the collection of all your WorkSpaces and pipes the IDs to the -WorkSpaceId parameter of Stop-WKSWorkspace causing the WorkSpaces to be stopped.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> $arrRequest = @() $request1 = New-Object Amazon.WorkSpaces.Model.StopRequest $request1.WorkspaceId = 'ws-12345678' $arrRequest += $request1 $request2 = New-Object Amazon.WorkSpaces.Model.StopRequest $request2.WorkspaceId = 'ws-abcdefgh' $arrRequest += $request2 Stop-WKSWorkspace -Request $arrRequest </code><remarks><para>Description</para><para>-----------</para><para>This example shows how to pass StopRequest objects defining the WorkSpaces to be stopped.</para><para /><para /></remarks> </example> </examples> </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>Edit-WKSWorkspaceProperty</name> <description> <para>Invokes the ModifyWorkspaceProperties operation against Amazon WorkSpaces.</para> </description> <verb>Edit</verb> <noun>WKSWorkspaceProperty</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the WorkSpace properties, including the running mode and AutoStop time. </para> </description> <syntax> <syntaxItem> <name>Edit-WKSWorkspaceProperty</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WorkspaceId</name> <description> <para>The ID of the WorkSpace. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WorkspaceProperties_RunningMode</name> <description> <para>The running mode of the WorkSpace. AlwaysOn WorkSpaces are billed monthly. AutoStop WorkSpaces are billed by the hour and stopped when no longer being used in order to save on costs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.RunningMode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WorkspaceProperties_RunningModeAutoStopTimeoutInMinute</name> <description> <para>The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkspaceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkspaceId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>WorkspaceId</name> <description> <para>The ID of the WorkSpace. </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="False" position="Named"> <name>WorkspaceProperties_RunningMode</name> <description> <para>The running mode of the WorkSpace. AlwaysOn WorkSpaces are billed monthly. AutoStop WorkSpaces are billed by the hour and stopped when no longer being used in order to save on costs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.RunningMode</parameterValue> <type> <name>Amazon.WorkSpaces.RunningMode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WorkspaceProperties_RunningModeAutoStopTimeoutInMinute</name> <description> <para>The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the WorkspaceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkSpaces.Model.ModifyWorkspacePropertiesResponse) 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=Edit-WKSWorkspaceProperty.html&tocid=Edit-WKSWorkspaceProperty</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</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>Get-WKSTag</name> <description> <para>Invokes the DescribeTags operation against Amazon WorkSpaces.</para> </description> <verb>Get</verb> <noun>WKSTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes tags for a WorkSpace. </para> </description> <syntax> <syntaxItem> <name>Get-WKSTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The resource ID of the request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The resource ID of the request. </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.WorkSpaces.Model.Tag</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Tag objects. The service call response (type Amazon.WorkSpaces.Model.DescribeTagsResponse) 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-WKSTag.html&tocid=Get-WKSTag</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</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>Get-WKSWorkspace</name> <description> <para>Invokes the DescribeWorkspaces operation against Amazon WorkSpaces.</para> </description> <verb>Get</verb> <noun>WKSWorkspace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Obtains information about the specified WorkSpaces. Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>, or <code>WorkspaceIds</code>, can be specified at a time. This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WKSWorkspace</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BundleId</name> <description> <para>The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DirectoryId</name> <description> <para>Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the <code>UserName</code> parameter. This parameter cannot be combined with any other filter parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserName</name> <description> <para>Used with the <code>DirectoryId</code> parameter to specify the directory user for whom to obtain the WorkSpace. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WorkspaceId</name> <description> <para>An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter. Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BundleId</name> <description> <para>The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter. </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="False" position="Named"> <name>DirectoryId</name> <description> <para>Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the <code>UserName</code> parameter. This parameter cannot be combined with any other filter parameter. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>UserName</name> <description> <para>Used with the <code>DirectoryId</code> parameter to specify the directory user for whom to obtain the WorkSpace. </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="False" position="Named"> <name>WorkspaceId</name> <description> <para>An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter. Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned. </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.WorkSpaces.Model.Workspace</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Workspace objects. The service call response (type Amazon.WorkSpaces.Model.DescribeWorkspacesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WKSWorkspace.html&tocid=Get-WKSWorkspace</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> Get-WKSWorkspace BundleId : wsb-1a2b3c4d ComputerName : DirectoryId : d-1a2b3c4d ErrorCode : ErrorMessage : IpAddress : RootVolumeEncryptionEnabled : False State : PENDING SubnetId : UserName : myuser UserVolumeEncryptionEnabled : False VolumeEncryptionKey : WorkspaceId : ws-1a2b3c4d WorkspaceProperties : Amazon.WorkSpaces.Model.WorkspaceProperties </code><remarks><para>Description</para><para>-----------</para><para>Retrieves details of all your WorkSpaces to the pipeline.</para><para /><para /></remarks> </example> </examples> </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>Get-WKSWorkspaceBundle</name> <description> <para>Invokes the DescribeWorkspaceBundles operation against Amazon WorkSpaces.</para> </description> <verb>Get</verb> <noun>WKSWorkspaceBundle</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Obtains information about the WorkSpace bundles that are available to your account in the specified region. You can filter the results with either the <code>BundleIds</code> parameter, or the <code>Owner</code> parameter, but not both. This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WKSWorkspaceBundle</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BundleId</name> <description> <para>An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Owner</name> <description> <para>The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter. This contains one of the following values: - null- Retrieves the bundles that belong to the account making the call. - <code>AMAZON</code>- Retrieves the bundles that are provided by AWS. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BundleId</name> <description> <para>An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter. </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="False" position="Named"> <name>NextToken</name> <description> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Owner</name> <description> <para>The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter. This contains one of the following values: - null- Retrieves the bundles that belong to the account making the call. - <code>AMAZON</code>- Retrieves the bundles that are provided by AWS. </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.WorkSpaces.Model.WorkspaceBundle</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of WorkspaceBundle objects. The service call response (type Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WKSWorkspaceBundle.html&tocid=Get-WKSWorkspaceBundle</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</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>Get-WKSWorkspaceDirectory</name> <description> <para>Invokes the DescribeWorkspaceDirectories operation against Amazon WorkSpaces.</para> </description> <verb>Get</verb> <noun>WKSWorkspaceDirectory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WKSWorkspaceDirectory</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DirectoryId</name> <description> <para>An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DirectoryId</name> <description> <para>An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved. </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="False" position="Named"> <name>NextToken</name> <description> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WorkSpaces.Model.WorkspaceDirectory</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of WorkspaceDirectory objects. The service call response (type Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WKSWorkspaceDirectory.html&tocid=Get-WKSWorkspaceDirectory</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</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>Get-WKSWorkspacesConnectionStatus</name> <description> <para>Invokes the DescribeWorkspacesConnectionStatus operation against Amazon WorkSpaces.</para> </description> <verb>Get</verb> <noun>WKSWorkspacesConnectionStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the connection status of a specified WorkSpace.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WKSWorkspacesConnectionStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WorkspaceId</name> <description> <para>An array of strings that contain the identifiers of the WorkSpaces. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The next token of the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The next token of the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>WorkspaceId</name> <description> <para>An array of strings that contain the identifiers of the WorkSpaces. </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.WorkSpaces.Model.WorkspaceConnectionStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of WorkspaceConnectionStatus objects. The service call response (type Amazon.WorkSpaces.Model.DescribeWorkspacesConnectionStatusResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WKSWorkspacesConnectionStatus.html&tocid=Get-WKSWorkspacesConnectionStatus</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</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>New-WKSTag</name> <description> <para>Invokes the CreateTags operation against Amazon WorkSpaces.</para> </description> <verb>New</verb> <noun>WKSTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates tags for a WorkSpace. </para> </description> <syntax> <syntaxItem> <name>New-WKSTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceId</name> <description> <para>The resource ID of the request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>The tags of the request. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>ResourceId</name> <description> <para>The resource ID of the request. </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="False" position="Named"> <name>Tag</name> <description> <para>The tags of the request. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.Tag[]</parameterValue> <type> <name>Amazon.WorkSpaces.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.WorkSpaces.Model.CreateTagsResponse) 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=New-WKSTag.html&tocid=New-WKSTag</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</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>New-WKSWorkspace</name> <description> <para>Invokes the CreateWorkspaces operation against Amazon WorkSpaces.</para> </description> <verb>New</verb> <noun>WKSWorkspace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. </para> </description> <syntax> <syntaxItem> <name>New-WKSWorkspace</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Workspace</name> <description> <para>An array of structures that specify the WorkSpaces to create. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.WorkspaceRequest[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Workspace</name> <description> <para>An array of structures that specify the WorkSpaces to create. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkSpaces.Model.WorkspaceRequest[]</parameterValue> <type> <name>Amazon.WorkSpaces.Model.WorkspaceRequest[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.WorkSpaces.Model.CreateWorkspacesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WorkSpaces.Model.CreateWorkspacesResponse 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=New-WKSWorkspace.html&tocid=New-WKSWorkspace</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}</code><remarks><para>Description</para><para>-----------</para><para>Create a WorkSpace for the supplied bundle, directory, and user.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}</code><remarks><para>Description</para><para>-----------</para><para>This example creates multiple WorkSpaces</para><para /><para /></remarks> </example> </examples> </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-WKSTag</name> <description> <para>Invokes the DeleteTags operation against Amazon WorkSpaces.</para> </description> <verb>Remove</verb> <noun>WKSTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes tags from a WorkSpace. </para> </description> <syntax> <syntaxItem> <name>Remove-WKSTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceId</name> <description> <para>The resource ID of the request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>The tag keys of the request. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>ResourceId</name> <description> <para>The resource ID of the request. </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="False" position="Named"> <name>TagKey</name> <description> <para>The tag keys of the request. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.WorkSpaces.Model.DeleteTagsResponse) 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-WKSTag.html&tocid=Remove-WKSTag</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> <navigationLink> <linkText>Administration Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/workspaces/latest/devguide/</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>Add-WDResourcePermission</name> <description> <para>Invokes the AddResourcePermissions operation against Amazon WorkDocs.</para> </description> <verb>Add</verb> <noun>WDResourcePermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions. </para> </description> <syntax> <syntaxItem> <name>Add-WDResourcePermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Principal</name> <description> <para>The users, groups, or organization being granted permission. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.Model.SharePrincipal[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" 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="False" position="Named"> <name>Principal</name> <description> <para>The users, groups, or organization being granted permission. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.Model.SharePrincipal[]</parameterValue> <type> <name>Amazon.WorkDocs.Model.SharePrincipal[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </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.WorkDocs.Model.ShareResult</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ShareResult objects. The service call response (type Amazon.WorkDocs.Model.AddResourcePermissionsResponse) 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=Add-WDResourcePermission.html&tocid=Add-WDResourcePermission</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>Disable-WDUser</name> <description> <para>Invokes the DeactivateUser operation against Amazon WorkDocs.</para> </description> <verb>Disable</verb> <noun>WDUser</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deactivates the specified user, which revokes the user's access to Amazon WorkDocs. </para> </description> <syntax> <syntaxItem> <name>Disable-WDUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>UserId</name> <description> <para>The ID of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>UserId</name> <description> <para>The ID of the user. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the UserId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeactivateUserResponse) 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=Disable-WDUser.html&tocid=Disable-WDUser</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>Enable-WDUser</name> <description> <para>Invokes the ActivateUser operation against Amazon WorkDocs.</para> </description> <verb>Enable</verb> <noun>WDUser</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Activates the specified user. Only active users can access Amazon WorkDocs. </para> </description> <syntax> <syntaxItem> <name>Enable-WDUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>UserId</name> <description> <para>The ID of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" 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 (ByValue, )" position="1"> <name>UserId</name> <description> <para>The ID of the user. </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.WorkDocs.Model.User</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a User object. The service call response (type Amazon.WorkDocs.Model.ActivateUserResponse) 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=Enable-WDUser.html&tocid=Enable-WDUser</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>Get-WDActivity</name> <description> <para>Invokes the DescribeActivities operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDActivity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the user activities in a specified time period.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WDActivity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The timestamp that determines the end time of the activities; the response includes the activities performed before the specified timestamp. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OrganizationId</name> <description> <para>The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para>The timestamp that determines the starting time of the activities; the response includes the activities performed after the specified timestamp. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserId</name> <description> <para>The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>EndTime</name> <description> <para>The timestamp that determines the end time of the activities; the response includes the activities performed before the specified timestamp. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>OrganizationId</name> <description> <para>The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests. </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="False" position="Named"> <name>StartTime</name> <description> <para>The timestamp that determines the starting time of the activities; the response includes the activities performed after the specified timestamp. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserId</name> <description> <para>The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests. </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.WorkDocs.Model.Activity</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Activity objects. The service call response (type Amazon.WorkDocs.Model.DescribeActivitiesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WDActivity.html&tocid=Get-WDActivity</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>Get-WDComment</name> <description> <para>Invokes the DescribeComments operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDComment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>List all the comments for the specified document version.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WDComment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>VersionId</name> <description> <para>The ID of the document version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. This marker was received from a previous call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. This marker was received from a previous call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>VersionId</name> <description> <para>The ID of the document version. </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.WorkDocs.Model.Comment</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Comment objects. The service call response (type Amazon.WorkDocs.Model.DescribeCommentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WDComment.html&tocid=Get-WDComment</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>Get-WDCurrentUser</name> <description> <para>Invokes the GetCurrentUser operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDCurrentUser</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. </para> </description> <syntax> <syntaxItem> <name>Get-WDCurrentUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. </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.WorkDocs.Model.User</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a User object. The service call response (type Amazon.WorkDocs.Model.GetCurrentUserResponse) 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-WDCurrentUser.html&tocid=Get-WDCurrentUser</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>Get-WDDocument</name> <description> <para>Invokes the GetDocument operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDDocument</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves details of a document. </para> </description> <syntax> <syntaxItem> <name>Get-WDDocument</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeCustomMetadata</name> <description> <para>Set this to <code>TRUE</code> to include custom metadata in the response. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" position="Named"> <name>IncludeCustomMetadata</name> <description> <para>Set this to <code>TRUE</code> to include custom metadata in the response. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.WorkDocs.Model.GetDocumentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WorkDocs.Model.GetDocumentResponse 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-WDDocument.html&tocid=Get-WDDocument</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>Get-WDDocumentPath</name> <description> <para>Invokes the GetDocumentPath operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDDocumentPath</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders. </para> </description> <syntax> <syntaxItem> <name>Get-WDDocumentPath</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Field</name> <description> <para>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of levels in the hierarchy to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>This value is not supported. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" position="Named"> <name>Field</name> <description> <para>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of levels in the hierarchy to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>This value is not supported. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WorkDocs.Model.ResourcePath</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ResourcePath object. The service call response (type Amazon.WorkDocs.Model.GetDocumentPathResponse) 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-WDDocumentPath.html&tocid=Get-WDDocumentPath</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>Get-WDDocumentVersion</name> <description> <para>Invokes the GetDocumentVersion operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDDocumentVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves version metadata for the specified document. </para> </description> <syntax> <syntaxItem> <name>Get-WDDocumentVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Field</name> <description> <para>A comma-separated list of values. Specify "SOURCE" to include a URL for the source document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeCustomMetadata</name> <description> <para>Set this to TRUE to include custom metadata in the response. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionId</name> <description> <para>The version ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" position="Named"> <name>Field</name> <description> <para>A comma-separated list of values. Specify "SOURCE" to include a URL for the source document. </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="False" position="Named"> <name>IncludeCustomMetadata</name> <description> <para>Set this to TRUE to include custom metadata in the response. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionId</name> <description> <para>The version ID of the document. </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.WorkDocs.Model.GetDocumentVersionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WorkDocs.Model.GetDocumentVersionResponse 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-WDDocumentVersion.html&tocid=Get-WDDocumentVersion</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>Get-WDDocumentVersionList</name> <description> <para>Invokes the DescribeDocumentVersions operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDDocumentVersionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the document versions for the specified document. By default, only active versions are returned. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WDDocumentVersionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Field</name> <description> <para>Specify "SOURCE" to include initialized versions and a URL for the source document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Include</name> <description> <para>A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of versions to return with this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" position="Named"> <name>Field</name> <description> <para>Specify "SOURCE" to include initialized versions and a URL for the source document. </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="False" position="Named"> <name>Include</name> <description> <para>A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of versions to return with this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WorkDocs.Model.DocumentVersionMetadata</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DocumentVersionMetadata objects. The service call response (type Amazon.WorkDocs.Model.DescribeDocumentVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WDDocumentVersionList.html&tocid=Get-WDDocumentVersionList</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>Get-WDFolder</name> <description> <para>Invokes the GetFolder operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDFolder</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the metadata of the specified folder. </para> </description> <syntax> <syntaxItem> <name>Get-WDFolder</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeCustomMetadata</name> <description> <para>Set to TRUE to include custom metadata in the response. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </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="False" position="Named"> <name>IncludeCustomMetadata</name> <description> <para>Set to TRUE to include custom metadata in the response. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.WorkDocs.Model.GetFolderResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WorkDocs.Model.GetFolderResponse 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-WDFolder.html&tocid=Get-WDFolder</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>Get-WDFolderContent</name> <description> <para>Invokes the DescribeFolderContents operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDFolderContent</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the contents of the specified folder, including its documents and subfolders. By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents. </para> </description> <syntax> <syntaxItem> <name>Get-WDFolderContent</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Include</name> <description> <para>The contents to include. Specify "INITIALIZED" to include initialized documents. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Order</name> <description> <para>The order for the contents of the folder. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.OrderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Sort</name> <description> <para>The sorting criteria. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.ResourceSortType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Type</name> <description> <para>The type of items. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.FolderContentType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return with this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. This marker was received from a previous call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </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="False" position="Named"> <name>Include</name> <description> <para>The contents to include. Specify "INITIALIZED" to include initialized documents. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return with this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. This marker was received from a previous call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Order</name> <description> <para>The order for the contents of the folder. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.OrderType</parameterValue> <type> <name>Amazon.WorkDocs.OrderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Sort</name> <description> <para>The sorting criteria. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.ResourceSortType</parameterValue> <type> <name>Amazon.WorkDocs.ResourceSortType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Type</name> <description> <para>The type of items. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.FolderContentType</parameterValue> <type> <name>Amazon.WorkDocs.FolderContentType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.WorkDocs.Model.DescribeFolderContentsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WorkDocs.Model.DescribeFolderContentsResponse 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-WDFolderContent.html&tocid=Get-WDFolderContent</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>Get-WDFolderPath</name> <description> <para>Invokes the GetFolderPath operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDFolderPath</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the path information (the hierarchy from the root folder) for the specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names. </para> </description> <syntax> <syntaxItem> <name>Get-WDFolderPath</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Field</name> <description> <para>A comma-separated list of values. Specify "NAME" to include the names of the parent folders. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of levels in the hierarchy to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>This value is not supported. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>Field</name> <description> <para>A comma-separated list of values. Specify "NAME" to include the names of the parent folders. </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 (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of levels in the hierarchy to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>This value is not supported. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WorkDocs.Model.ResourcePath</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ResourcePath object. The service call response (type Amazon.WorkDocs.Model.GetFolderPathResponse) 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-WDFolderPath.html&tocid=Get-WDFolderPath</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>Get-WDNotificationSubscriptionList</name> <description> <para>Invokes the DescribeNotificationSubscriptions operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDNotificationSubscriptionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the specified notification subscriptions.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WDNotificationSubscriptionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OrganizationId</name> <description> <para>The ID of the organization. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return with this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return with this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>OrganizationId</name> <description> <para>The ID of the organization. </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.WorkDocs.Model.Subscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Subscription objects. The service call response (type Amazon.WorkDocs.Model.DescribeNotificationSubscriptionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WDNotificationSubscriptionList.html&tocid=Get-WDNotificationSubscriptionList</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>Get-WDResourcePermissionList</name> <description> <para>Invokes the DescribeResourcePermissions operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDResourcePermissionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the permissions of a specified resource.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WDResourcePermissionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return with this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return with this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </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.WorkDocs.Model.Principal</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Principal objects. The service call response (type Amazon.WorkDocs.Model.DescribeResourcePermissionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WDResourcePermissionList.html&tocid=Get-WDResourcePermissionList</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>Get-WDRootFolder</name> <description> <para>Invokes the DescribeRootFolders operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDRootFolder</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the current user's special folders; the <code>RootFolder</code> and the <code>RecyleBin</code>. <code>RootFolder</code> is the root of user's files and folders and <code>RecyleBin</code> is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WDRootFolder</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WorkDocs.Model.FolderMetadata</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of FolderMetadata objects. The service call response (type Amazon.WorkDocs.Model.DescribeRootFoldersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WDRootFolder.html&tocid=Get-WDRootFolder</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>Get-WDUserList</name> <description> <para>Invokes the DescribeUsers operation against Amazon WorkDocs.</para> </description> <verb>Get</verb> <noun>WDUserList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the specified users. You can describe all users or filter the results (for example, by status or organization). By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WDUserList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OrganizationId</name> <description> <para>The ID of the organization. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Field</name> <description> <para>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Include</name> <description> <para>The state of the users. Specify "ALL" to include inactive users. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.UserFilterType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Order</name> <description> <para>The order for the results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.OrderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Query</name> <description> <para>A query to filter users by user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Sort</name> <description> <para>The sorting criteria. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.UserSortType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserId</name> <description> <para>The IDs of the users. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>Field</name> <description> <para>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization 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="False" position="Named"> <name>Include</name> <description> <para>The state of the users. Specify "ALL" to include inactive users. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.UserFilterType</parameterValue> <type> <name>Amazon.WorkDocs.UserFilterType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of items to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The marker for the next set of results. (You received this marker from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Order</name> <description> <para>The order for the results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.OrderType</parameterValue> <type> <name>Amazon.WorkDocs.OrderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OrganizationId</name> <description> <para>The ID of the organization. </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="False" position="Named"> <name>Query</name> <description> <para>A query to filter users by user name. </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="False" position="Named"> <name>Sort</name> <description> <para>The sorting criteria. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.UserSortType</parameterValue> <type> <name>Amazon.WorkDocs.UserSortType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UserId</name> <description> <para>The IDs of the users. </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.WorkDocs.Model.User</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of User objects. The service call response (type Amazon.WorkDocs.Model.DescribeUsersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String), TotalNumberOfUsers (type System.Int64)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WDUserList.html&tocid=Get-WDUserList</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>New-WDComment</name> <description> <para>Invokes the CreateComment operation against Amazon WorkDocs.</para> </description> <verb>New</verb> <noun>WDComment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds a new comment to the specified document version. </para> </description> <syntax> <syntaxItem> <name>New-WDComment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Text</name> <description> <para>The text of the comment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotifyCollaborator</name> <description> <para>Set this parameter to TRUE to send an email out to the document collaborators after the comment is created. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ParentId</name> <description> <para>The ID of the parent comment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ThreadId</name> <description> <para>The ID of the root comment in the thread. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the document version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Visibility</name> <description> <para>The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.CommentVisibilityType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" 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="False" position="Named"> <name>NotifyCollaborator</name> <description> <para>Set this parameter to TRUE to send an email out to the document collaborators after the comment is created. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ParentId</name> <description> <para>The ID of the parent comment. </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 (ByValue, )" position="1"> <name>Text</name> <description> <para>The text of the comment. </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="False" position="Named"> <name>ThreadId</name> <description> <para>The ID of the root comment in the thread. </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="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the document version. </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="False" position="Named"> <name>Visibility</name> <description> <para>The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.CommentVisibilityType</parameterValue> <type> <name>Amazon.WorkDocs.CommentVisibilityType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.WorkDocs.Model.Comment</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Comment object. The service call response (type Amazon.WorkDocs.Model.CreateCommentResponse) 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=New-WDComment.html&tocid=New-WDComment</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>New-WDCustomMetadata</name> <description> <para>Invokes the CreateCustomMetadata operation against Amazon WorkDocs.</para> </description> <verb>New</verb> <noun>WDCustomMetadata</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds one or more custom properties to the specified resource (a folder, document, or version). </para> </description> <syntax> <syntaxItem> <name>New-WDCustomMetadata</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomMetadata</name> <description> <para>Custom metadata in the form of name-value pairs. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the version, if the custom metadata is being added to a document version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>CustomMetadata</name> <description> <para>Custom metadata in the form of name-value pairs. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </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="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the version, if the custom metadata is being added to a document version. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.CreateCustomMetadataResponse) 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=New-WDCustomMetadata.html&tocid=New-WDCustomMetadata</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>New-WDFolder</name> <description> <para>Invokes the CreateFolder operation against Amazon WorkDocs.</para> </description> <verb>New</verb> <noun>WDFolder</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a folder with the specified name and parent folder. </para> </description> <syntax> <syntaxItem> <name>New-WDFolder</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ParentFolderId</name> <description> <para>The ID of the parent folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The name of the new folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>The name of the new folder. </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 (ByValue, )" position="1"> <name>ParentFolderId</name> <description> <para>The ID of the parent folder. </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.WorkDocs.Model.FolderMetadata</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a FolderMetadata object. The service call response (type Amazon.WorkDocs.Model.CreateFolderResponse) 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=New-WDFolder.html&tocid=New-WDFolder</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>New-WDLabel</name> <description> <para>Invokes the CreateLabels operation against Amazon WorkDocs.</para> </description> <verb>New</verb> <noun>WDLabel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds the specified list of labels to the given resource (a document or folder) </para> </description> <syntax> <syntaxItem> <name>New-WDLabel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Label</name> <description> <para>List of labels to add to the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" 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="False" position="Named"> <name>Label</name> <description> <para>List of labels to add to the resource. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.CreateLabelsResponse) 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=New-WDLabel.html&tocid=New-WDLabel</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>New-WDNotificationSubscription</name> <description> <para>Invokes the CreateNotificationSubscription operation against Amazon WorkDocs.</para> </description> <verb>New</verb> <noun>WDNotificationSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Configure WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.confirm">Confirm the Subscription</a> in the <i>Amazon Simple Notification Service Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>New-WDNotificationSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OrganizationId</name> <description> <para>The ID of the organization. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Endpoint</name> <description> <para>The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with "https://". </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Protocol</name> <description> <para>The protocol to use. The supported value is https, which delivers JSON-encoded messasges using HTTPS POST. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.SubscriptionProtocolType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SubscriptionType</name> <description> <para>The notification type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.SubscriptionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Endpoint</name> <description> <para>The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with "https://". </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="False" 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 (ByValue, )" position="1"> <name>OrganizationId</name> <description> <para>The ID of the organization. </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="False" position="Named"> <name>Protocol</name> <description> <para>The protocol to use. The supported value is https, which delivers JSON-encoded messasges using HTTPS POST. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.SubscriptionProtocolType</parameterValue> <type> <name>Amazon.WorkDocs.SubscriptionProtocolType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SubscriptionType</name> <description> <para>The notification type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.SubscriptionType</parameterValue> <type> <name>Amazon.WorkDocs.SubscriptionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.WorkDocs.Model.Subscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Subscription object. The service call response (type Amazon.WorkDocs.Model.CreateNotificationSubscriptionResponse) 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=New-WDNotificationSubscription.html&tocid=New-WDNotificationSubscription</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>New-WDUser</name> <description> <para>Invokes the CreateUser operation against Amazon WorkDocs.</para> </description> <verb>New</verb> <noun>WDUser</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs. </para> </description> <syntax> <syntaxItem> <name>New-WDUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OrganizationId</name> <description> <para>The ID of the organization. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailAddress</name> <description> <para>The email address of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GivenName</name> <description> <para>The given name of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Password</name> <description> <para>The password of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageRule_StorageAllocatedInByte</name> <description> <para>The amount of storage allocated, in bytes. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageRule_StorageType</name> <description> <para>The type of storage. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.StorageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Surname</name> <description> <para>The surname of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeZoneId</name> <description> <para>The time zone ID of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Username</name> <description> <para>The login name of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>EmailAddress</name> <description> <para>The email address of the user. </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="False" 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="False" position="Named"> <name>GivenName</name> <description> <para>The given name of the user. </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 (ByValue, )" position="1"> <name>OrganizationId</name> <description> <para>The ID of the organization. </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="False" position="Named"> <name>Password</name> <description> <para>The password of the user. </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="False" position="Named"> <name>StorageRule_StorageAllocatedInByte</name> <description> <para>The amount of storage allocated, in bytes. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageRule_StorageType</name> <description> <para>The type of storage. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.StorageType</parameterValue> <type> <name>Amazon.WorkDocs.StorageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Surname</name> <description> <para>The surname of the user. </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="False" position="Named"> <name>TimeZoneId</name> <description> <para>The time zone ID of the user. </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="False" position="Named"> <name>Username</name> <description> <para>The login name of the user. </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.WorkDocs.Model.User</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a User object. The service call response (type Amazon.WorkDocs.Model.CreateUserResponse) 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=New-WDUser.html&tocid=New-WDUser</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-WDComment</name> <description> <para>Invokes the DeleteComment operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDComment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified comment from the document version. </para> </description> <syntax> <syntaxItem> <name>Remove-WDComment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CommentId</name> <description> <para>The ID of the comment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the document version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the CommentId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>CommentId</name> <description> <para>The ID of the comment. </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="False" position="Named"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the CommentId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the document version. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the CommentId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeleteCommentResponse) 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-WDComment.html&tocid=Remove-WDComment</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-WDCustomMetadata</name> <description> <para>Invokes the DeleteCustomMetadata operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDCustomMetadata</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes custom metadata from the specified resource. </para> </description> <syntax> <syntaxItem> <name>Remove-WDCustomMetadata</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource, either a document or folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeleteAll</name> <description> <para>Flag to indicate removal of all custom metadata properties from the specified resource. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Key</name> <description> <para>List of properties to remove. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the version, if the custom metadata is being deleted from a document version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>DeleteAll</name> <description> <para>Flag to indicate removal of all custom metadata properties from the specified resource. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Key</name> <description> <para>List of properties to remove. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource, either a document or folder. </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="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the version, if the custom metadata is being deleted from a document version. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeleteCustomMetadataResponse) 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-WDCustomMetadata.html&tocid=Remove-WDCustomMetadata</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-WDDocument</name> <description> <para>Invokes the DeleteDocument operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDDocument</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes the specified document and its associated metadata. </para> </description> <syntax> <syntaxItem> <name>Remove-WDDocument</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DocumentId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DocumentId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DocumentId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeleteDocumentResponse) 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-WDDocument.html&tocid=Remove-WDDocument</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-WDFolder</name> <description> <para>Invokes the DeleteFolder operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDFolder</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes the specified folder and its contents. </para> </description> <syntax> <syntaxItem> <name>Remove-WDFolder</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the FolderId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the FolderId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the FolderId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeleteFolderResponse) 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-WDFolder.html&tocid=Remove-WDFolder</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-WDFolderContent</name> <description> <para>Invokes the DeleteFolderContents operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDFolderContent</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the contents of the specified folder. </para> </description> <syntax> <syntaxItem> <name>Remove-WDFolderContent</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the FolderId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the FolderId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the FolderId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeleteFolderContentsResponse) 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-WDFolderContent.html&tocid=Remove-WDFolderContent</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-WDLabel</name> <description> <para>Invokes the DeleteLabels operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDLabel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified list of labels from a resource. </para> </description> <syntax> <syntaxItem> <name>Remove-WDLabel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Label</name> <description> <para>List of labels to delete from the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeleteAll</name> <description> <para>Flag to request removal of all labels from the specified resource. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceId</name> <description> <para>The ID of the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Label parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>DeleteAll</name> <description> <para>Flag to request removal of all labels from the specified resource. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Label</name> <description> <para>List of labels to delete from the resource. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Label parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ResourceId</name> <description> <para>The ID of the resource. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Label parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeleteLabelsResponse) 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-WDLabel.html&tocid=Remove-WDLabel</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-WDNotificationSubscription</name> <description> <para>Invokes the DeleteNotificationSubscription operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDNotificationSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified subscription from the specified organization. </para> </description> <syntax> <syntaxItem> <name>Remove-WDNotificationSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SubscriptionId</name> <description> <para>The ID of the subscription. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OrganizationId</name> <description> <para>The ID of the organization. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SubscriptionId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>OrganizationId</name> <description> <para>The ID of the organization. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SubscriptionId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>SubscriptionId</name> <description> <para>The ID of the subscription. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SubscriptionId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeleteNotificationSubscriptionResponse) 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-WDNotificationSubscription.html&tocid=Remove-WDNotificationSubscription</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-WDResourcePermission</name> <description> <para>Invokes the RemoveResourcePermission operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDResourcePermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes the permission for the specified principal from the specified resource. </para> </description> <syntax> <syntaxItem> <name>Remove-WDResourcePermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrincipalId</name> <description> <para>The principal ID of the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrincipalType</name> <description> <para>The principal type of the resource. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.PrincipalType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>PrincipalId</name> <description> <para>The principal ID of the resource. </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="False" position="Named"> <name>PrincipalType</name> <description> <para>The principal type of the resource. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.PrincipalType</parameterValue> <type> <name>Amazon.WorkDocs.PrincipalType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.RemoveResourcePermissionResponse) 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-WDResourcePermission.html&tocid=Remove-WDResourcePermission</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-WDUser</name> <description> <para>Invokes the DeleteUser operation against Amazon WorkDocs.</para> </description> <verb>Remove</verb> <noun>WDUser</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified user from a Simple AD or Microsoft AD directory. </para> </description> <syntax> <syntaxItem> <name>Remove-WDUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>UserId</name> <description> <para>The ID of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>UserId</name> <description> <para>The ID of the user. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the UserId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.DeleteUserResponse) 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-WDUser.html&tocid=Remove-WDUser</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>Start-WDDocumentVersionUpload</name> <description> <para>Invokes the InitiateDocumentVersionUpload operation against Amazon WorkDocs.</para> </description> <verb>Start</verb> <noun>WDDocumentVersionUpload</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new document object and version object. The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call <a>UpdateDocumentVersion</a>. To cancel the document upload, call <a>AbortDocumentVersionUpload</a>. </para> </description> <syntax> <syntaxItem> <name>Start-WDDocumentVersionUpload</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentCreatedTimestamp</name> <description> <para>The time stamp when the content of the document was originally created. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentModifiedTimestamp</name> <description> <para>The time stamp when the content of the document was modified. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>The content type of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentSizeInByte</name> <description> <para>The size of the document, in bytes. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The name of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ParentFolderId</name> <description> <para>The ID of the parent folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" position="Named"> <name>ContentCreatedTimestamp</name> <description> <para>The time stamp when the content of the document was originally created. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentModifiedTimestamp</name> <description> <para>The time stamp when the content of the document was modified. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>The content type of the document. </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="False" position="Named"> <name>DocumentSizeInByte</name> <description> <para>The size of the document, in bytes. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The ID of the document. </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="False" position="Named"> <name>Name</name> <description> <para>The name of the document. </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="False" position="Named"> <name>ParentFolderId</name> <description> <para>The ID of the parent folder. </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.WorkDocs.Model.InitiateDocumentVersionUploadResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WorkDocs.Model.InitiateDocumentVersionUploadResponse 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=Start-WDDocumentVersionUpload.html&tocid=Start-WDDocumentVersionUpload</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>Stop-WDDocumentVersionUpload</name> <description> <para>Invokes the AbortDocumentVersionUpload operation against Amazon WorkDocs.</para> </description> <verb>Stop</verb> <noun>WDDocumentVersionUpload</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Aborts the upload of the specified document version that was previously initiated by <a>InitiateDocumentVersionUpload</a>. The client should make this call only when it no longer intends to upload the document version, or fails to do so. </para> </description> <syntax> <syntaxItem> <name>Stop-WDDocumentVersionUpload</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DocumentId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DocumentId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>VersionId</name> <description> <para>The ID of the version. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DocumentId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.AbortDocumentVersionUploadResponse) 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=Stop-WDDocumentVersionUpload.html&tocid=Stop-WDDocumentVersionUpload</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>Update-WDDocument</name> <description> <para>Invokes the UpdateDocument operation against Amazon WorkDocs.</para> </description> <verb>Update</verb> <noun>WDDocument</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable. </para> </description> <syntax> <syntaxItem> <name>Update-WDDocument</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The name of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ParentFolderId</name> <description> <para>The ID of the parent folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceState</name> <description> <para>The resource state of the document. Note that only ACTIVE and RECYCLED are supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.ResourceStateType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DocumentId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>The name of the document. </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="False" position="Named"> <name>ParentFolderId</name> <description> <para>The ID of the parent folder. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DocumentId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ResourceState</name> <description> <para>The resource state of the document. Note that only ACTIVE and RECYCLED are supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.ResourceStateType</parameterValue> <type> <name>Amazon.WorkDocs.ResourceStateType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DocumentId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.UpdateDocumentResponse) 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=Update-WDDocument.html&tocid=Update-WDDocument</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>Update-WDDocumentVersion</name> <description> <para>Invokes the UpdateDocumentVersion operation against Amazon WorkDocs.</para> </description> <verb>Update</verb> <noun>WDDocumentVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by <a>InitiateDocumentVersionUpload</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WDDocumentVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionId</name> <description> <para>The version ID of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionStatus</name> <description> <para>The status of the version. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.DocumentVersionStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DocumentId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>DocumentId</name> <description> <para>The ID of the document. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DocumentId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>VersionId</name> <description> <para>The version ID of the document. </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="False" position="Named"> <name>VersionStatus</name> <description> <para>The status of the version. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.DocumentVersionStatus</parameterValue> <type> <name>Amazon.WorkDocs.DocumentVersionStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DocumentId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.UpdateDocumentVersionResponse) 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=Update-WDDocumentVersion.html&tocid=Update-WDDocumentVersion</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>Update-WDFolder</name> <description> <para>Invokes the UpdateFolder operation against Amazon WorkDocs.</para> </description> <verb>Update</verb> <noun>WDFolder</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable. </para> </description> <syntax> <syntaxItem> <name>Update-WDFolder</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The name of the folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ParentFolderId</name> <description> <para>The ID of the parent folder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceState</name> <description> <para>The resource state of the folder. Note that only ACTIVE and RECYCLED are accepted values from the API. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.ResourceStateType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the FolderId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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 (ByValue, )" position="1"> <name>FolderId</name> <description> <para>The ID of the folder. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>The name of the folder. </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="False" position="Named"> <name>ParentFolderId</name> <description> <para>The ID of the parent folder. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the FolderId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ResourceState</name> <description> <para>The resource state of the folder. Note that only ACTIVE and RECYCLED are accepted values from the API. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.ResourceStateType</parameterValue> <type> <name>Amazon.WorkDocs.ResourceStateType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the FolderId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WorkDocs.Model.UpdateFolderResponse) 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=Update-WDFolder.html&tocid=Update-WDFolder</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>Update-WDUser</name> <description> <para>Invokes the UpdateUser operation against Amazon WorkDocs.</para> </description> <verb>Update</verb> <noun>WDUser</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site. </para> </description> <syntax> <syntaxItem> <name>Update-WDUser</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>UserId</name> <description> <para>The ID of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GivenName</name> <description> <para>The given name of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Locale</name> <description> <para>The locale of the user. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.LocaleType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageRule_StorageAllocatedInByte</name> <description> <para>The amount of storage allocated, in bytes. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageRule_StorageType</name> <description> <para>The type of storage. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.StorageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Surname</name> <description> <para>The surname of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeZoneId</name> <description> <para>The time zone ID of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Type</name> <description> <para>The type of the user. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.UserType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationToken</name> <description> <para>Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials. </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="False" 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="False" position="Named"> <name>GivenName</name> <description> <para>The given name of the user. </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="False" position="Named"> <name>Locale</name> <description> <para>The locale of the user. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.LocaleType</parameterValue> <type> <name>Amazon.WorkDocs.LocaleType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageRule_StorageAllocatedInByte</name> <description> <para>The amount of storage allocated, in bytes. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageRule_StorageType</name> <description> <para>The type of storage. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.StorageType</parameterValue> <type> <name>Amazon.WorkDocs.StorageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Surname</name> <description> <para>The surname of the user. </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="False" position="Named"> <name>TimeZoneId</name> <description> <para>The time zone ID of the user. </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="False" position="Named"> <name>Type</name> <description> <para>The type of the user. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WorkDocs.UserType</parameterValue> <type> <name>Amazon.WorkDocs.UserType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>UserId</name> <description> <para>The ID of the user. </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.WorkDocs.Model.User</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a User object. The service call response (type Amazon.WorkDocs.Model.UpdateUserResponse) 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=Update-WDUser.html&tocid=Update-WDUser</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>Get-WAFByteMatchSet</name> <description> <para>Invokes the GetByteMatchSet operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFByteMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>ByteMatchSet</a> specified by <code>ByteMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFByteMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to get. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to get. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </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.WAF.Model.ByteMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ByteMatchSet object. The service call response (type Amazon.WAF.Model.GetByteMatchSetResponse) 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-WAFByteMatchSet.html&tocid=Get-WAFByteMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFByteMatchSetList</name> <description> <para>Invokes the ListByteMatchSets operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFByteMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>ByteMatchSetSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFByteMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>ByteMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>ByteMatchSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>ByteMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>ByteMatchSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListByteMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ByteMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>ByteMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>ByteMatchSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>ByteMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>ByteMatchSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListByteMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ByteMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.ByteMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ByteMatchSetSummary objects. The service call response (type Amazon.WAF.Model.ListByteMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFByteMatchSetList.html&tocid=Get-WAFByteMatchSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFChangeToken</name> <description> <para>Invokes the GetChangeToken operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFChangeToken</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a <code>GetChangeToken</code> request and then submits a second <code>GetChangeToken</code> request before submitting a create, update, or delete request, the second <code>GetChangeToken</code> request returns the same value as the first <code>GetChangeToken</code> request. When you use a change token in a create, update, or delete request, the status of the change token changes to <code>PENDING</code>, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use <code>GetChangeTokenStatus</code> to determine the status of your change token. </para> </description> <syntax> <syntaxItem> <name>Get-WAFChangeToken</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.GetChangeTokenResponse) 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-WAFChangeToken.html&tocid=Get-WAFChangeToken</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFChangeTokenStatus</name> <description> <para>Invokes the GetChangeTokenStatus operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFChangeTokenStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the status of a <code>ChangeToken</code> that you got by calling <a>GetChangeToken</a>. <code>ChangeTokenStatus</code> is one of the following values: - <code>PROVISIONED</code>: You requested the change token by calling <code>GetChangeToken</code>, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. - <code>PENDING</code>: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. - <code>IN_SYNC</code>: Propagation is complete. </para> </description> <syntax> <syntaxItem> <name>Get-WAFChangeTokenStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The change token for which you want to get the status. This change token was previously returned in the <code>GetChangeToken</code> response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The change token for which you want to get the status. This change token was previously returned in the <code>GetChangeToken</code> response. </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.WAF.ChangeTokenStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ChangeTokenStatus object. The service call response (type Amazon.WAF.Model.GetChangeTokenStatusResponse) 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-WAFChangeTokenStatus.html&tocid=Get-WAFChangeTokenStatus</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFGeoMatchSet</name> <description> <para>Invokes the GetGeoMatchSet operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFGeoMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>GeoMatchSet</a> that is specified by <code>GeoMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFGeoMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to get. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to get. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </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.WAF.Model.GeoMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a GeoMatchSet object. The service call response (type Amazon.WAF.Model.GetGeoMatchSetResponse) 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-WAFGeoMatchSet.html&tocid=Get-WAFGeoMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFGeoMatchSetList</name> <description> <para>Invokes the ListGeoMatchSets operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFGeoMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>GeoMatchSetSummary</a> objects in the response.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFGeoMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>GeoMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>GeoMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>GeoMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>GeoMatchSet</code>s than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>GeoMatchSet</code> objects. For the second and subsequent <code>ListGeoMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>GeoMatchSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>GeoMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>GeoMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>GeoMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>GeoMatchSet</code>s than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>GeoMatchSet</code> objects. For the second and subsequent <code>ListGeoMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>GeoMatchSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.GeoMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of GeoMatchSetSummary objects. The service call response (type Amazon.WAF.Model.ListGeoMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFGeoMatchSetList.html&tocid=Get-WAFGeoMatchSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFIPSet</name> <description> <para>Invokes the GetIPSet operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFIPSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>IPSet</a> that is specified by <code>IPSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFIPSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to get. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to get. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </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.WAF.Model.IPSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a IPSet object. The service call response (type Amazon.WAF.Model.GetIPSetResponse) 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-WAFIPSet.html&tocid=Get-WAFIPSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFIPSetList</name> <description> <para>Invokes the ListIPSets operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFIPSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>IPSetSummary</a> objects in the response.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFIPSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>IPSet</code> objects that you want AWS WAF to return for this request. If you have more <code>IPSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>IPSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>IPSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>IPSet</code> objects that you want AWS WAF to return for this request. If you have more <code>IPSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>IPSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>IPSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.IPSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of IPSetSummary objects. The service call response (type Amazon.WAF.Model.ListIPSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFIPSetList.html&tocid=Get-WAFIPSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRateBasedRule</name> <description> <para>Invokes the GetRateBasedRule operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRateBasedRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>RateBasedRule</a> that is specified by the <code>RuleId</code> that you included in the <code>GetRateBasedRule</code> request. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRateBasedRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </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.WAF.Model.RateBasedRule</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RateBasedRule object. The service call response (type Amazon.WAF.Model.GetRateBasedRuleResponse) 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-WAFRateBasedRule.html&tocid=Get-WAFRateBasedRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRateBasedRuleList</name> <description> <para>Invokes the ListRateBasedRules operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRateBasedRuleList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>RuleSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRateBasedRuleList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRateBasedRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRateBasedRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.RuleSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RuleSummary objects. The service call response (type Amazon.WAF.Model.ListRateBasedRulesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRateBasedRuleList.html&tocid=Get-WAFRateBasedRuleList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRateBasedRuleManagedKey</name> <description> <para>Invokes the GetRateBasedRuleManagedKeys operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRateBasedRuleManagedKey</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of IP addresses currently being blocked by the <a>RateBasedRule</a> that is specified by the <code>RuleId</code>. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRateBasedRuleManagedKey</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> for which you want to get a list of <code>ManagedKeys</code>. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>A null value and not currently used. Do not include this in your request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>A null value and not currently used. Do not include this in your request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> for which you want to get a list of <code>ManagedKeys</code>. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.WAF.Model.GetRateBasedRuleManagedKeysResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRateBasedRuleManagedKey.html&tocid=Get-WAFRateBasedRuleManagedKey</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRegexMatchSet</name> <description> <para>Invokes the GetRegexMatchSet operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRegexMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>RegexMatchSet</a> specified by <code>RegexMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRegexMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to get. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to get. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </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.WAF.Model.RegexMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RegexMatchSet object. The service call response (type Amazon.WAF.Model.GetRegexMatchSetResponse) 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-WAFRegexMatchSet.html&tocid=Get-WAFRegexMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRegexMatchSetList</name> <description> <para>Invokes the ListRegexMatchSets operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRegexMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>RegexMatchSetSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRegexMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>RegexMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexMatchSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListRegexMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexMatchSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>RegexMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexMatchSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListRegexMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexMatchSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.RegexMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RegexMatchSetSummary objects. The service call response (type Amazon.WAF.Model.ListRegexMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRegexMatchSetList.html&tocid=Get-WAFRegexMatchSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRegexPatternSet</name> <description> <para>Invokes the GetRegexPatternSet operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRegexPatternSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>RegexPatternSet</a> specified by <code>RegexPatternSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRegexPatternSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to get. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to get. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </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.WAF.Model.RegexPatternSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RegexPatternSet object. The service call response (type Amazon.WAF.Model.GetRegexPatternSetResponse) 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-WAFRegexPatternSet.html&tocid=Get-WAFRegexPatternSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRegexPatternSetList</name> <description> <para>Invokes the ListRegexPatternSets operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRegexPatternSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>RegexPatternSetSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRegexPatternSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>RegexPatternSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexPatternSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexPatternSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexPatternSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>RegexPatternSet</code> objects. For the second and subsequent <code>ListRegexPatternSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexPatternSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>RegexPatternSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexPatternSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexPatternSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexPatternSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>RegexPatternSet</code> objects. For the second and subsequent <code>ListRegexPatternSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexPatternSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.RegexPatternSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RegexPatternSetSummary objects. The service call response (type Amazon.WAF.Model.ListRegexPatternSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRegexPatternSetList.html&tocid=Get-WAFRegexPatternSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRule</name> <description> <para>Invokes the GetRule operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>Rule</a> that is specified by the <code>RuleId</code> that you included in the <code>GetRule</code> request. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>. </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.WAF.Model.Rule</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Rule object. The service call response (type Amazon.WAF.Model.GetRuleResponse) 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-WAFRule.html&tocid=Get-WAFRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRuleList</name> <description> <para>Invokes the ListRules operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFRuleList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>RuleSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRuleList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.RuleSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RuleSummary objects. The service call response (type Amazon.WAF.Model.ListRulesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRuleList.html&tocid=Get-WAFRuleList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFSampledRequestList</name> <description> <para>Invokes the GetSampledRequests operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFSampledRequestList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. <code>GetSampledRequests</code> returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, <code>GetSampledRequests</code> returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. </para> </description> <syntax> <syntaxItem> <name>Get-WAFSampledRequestList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeWindow_EndTime</name> <description> <para>The end of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RuleId</name> <description> <para><code>RuleId</code> is one of two values: - The <code>RuleId</code> of the <code>Rule</code> for which you want <code>GetSampledRequests</code> to return a sample of requests. - <code>Default_Action</code>, which causes <code>GetSampledRequests</code> to return a sample of the requests that didn't match any of the rules in the specified <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeWindow_StartTime</name> <description> <para>The beginning of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WebAclId</name> <description> <para>The <code>WebACLId</code> of the <code>WebACL</code> for which you want <code>GetSampledRequests</code> to return a sample of requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RuleId</name> <description> <para><code>RuleId</code> is one of two values: - The <code>RuleId</code> of the <code>Rule</code> for which you want <code>GetSampledRequests</code> to return a sample of requests. - <code>Default_Action</code>, which causes <code>GetSampledRequests</code> to return a sample of the requests that didn't match any of the rules in the specified <code>WebACL</code>. </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="False" position="Named"> <name>TimeWindow_EndTime</name> <description> <para>The end of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeWindow_StartTime</name> <description> <para>The beginning of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WebAclId</name> <description> <para>The <code>WebACLId</code> of the <code>WebACL</code> for which you want <code>GetSampledRequests</code> to return a sample of requests. </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.WAF.Model.GetSampledRequestsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.GetSampledRequestsResponse 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-WAFSampledRequestList.html&tocid=Get-WAFSampledRequestList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFSizeConstraintSet</name> <description> <para>Invokes the GetSizeConstraintSet operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFSizeConstraintSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>SizeConstraintSet</a> specified by <code>SizeConstraintSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFSizeConstraintSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to get. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to get. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </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.WAF.Model.SizeConstraintSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SizeConstraintSet object. The service call response (type Amazon.WAF.Model.GetSizeConstraintSetResponse) 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-WAFSizeConstraintSet.html&tocid=Get-WAFSizeConstraintSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFSizeConstraintSetList</name> <description> <para>Invokes the ListSizeConstraintSets operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFSizeConstraintSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>SizeConstraintSetSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFSizeConstraintSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>SizeConstraintSet</code> objects that you want AWS WAF to return for this request. If you have more <code>SizeConstraintSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>SizeConstraintSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>SizeConstraintSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SizeConstraintSets</code>. For the second and subsequent <code>ListSizeConstraintSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SizeConstraintSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>SizeConstraintSet</code> objects that you want AWS WAF to return for this request. If you have more <code>SizeConstraintSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>SizeConstraintSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>SizeConstraintSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SizeConstraintSets</code>. For the second and subsequent <code>ListSizeConstraintSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SizeConstraintSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.SizeConstraintSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of SizeConstraintSetSummary objects. The service call response (type Amazon.WAF.Model.ListSizeConstraintSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFSizeConstraintSetList.html&tocid=Get-WAFSizeConstraintSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFSqlInjectionMatchSet</name> <description> <para>Invokes the GetSqlInjectionMatchSet operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFSqlInjectionMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>SqlInjectionMatchSet</a> that is specified by <code>SqlInjectionMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFSqlInjectionMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to get. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to get. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </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.WAF.Model.SqlInjectionMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SqlInjectionMatchSet object. The service call response (type Amazon.WAF.Model.GetSqlInjectionMatchSetResponse) 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-WAFSqlInjectionMatchSet.html&tocid=Get-WAFSqlInjectionMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFSqlInjectionMatchSetList</name> <description> <para>Invokes the ListSqlInjectionMatchSets operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFSqlInjectionMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>SqlInjectionMatchSet</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFSqlInjectionMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <a>SqlInjectionMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>SqlInjectionMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <a>SqlInjectionMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SqlInjectionMatchSets</code>. For the second and subsequent <code>ListSqlInjectionMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SqlInjectionMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <a>SqlInjectionMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>SqlInjectionMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <a>SqlInjectionMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SqlInjectionMatchSets</code>. For the second and subsequent <code>ListSqlInjectionMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SqlInjectionMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.SqlInjectionMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of SqlInjectionMatchSetSummary objects. The service call response (type Amazon.WAF.Model.ListSqlInjectionMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFSqlInjectionMatchSetList.html&tocid=Get-WAFSqlInjectionMatchSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFWebACL</name> <description> <para>Invokes the GetWebACL operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>WebACL</a> that is specified by <code>WebACLId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to get. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to get. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </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.WAF.Model.WebACL</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a WebACL object. The service call response (type Amazon.WAF.Model.GetWebACLResponse) 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-WAFWebACL.html&tocid=Get-WAFWebACL</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFWebACLList</name> <description> <para>Invokes the ListWebACLs operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFWebACLList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>WebACLSummary</a> objects in the response.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFWebACLList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>WebACL</code> objects that you want AWS WAF to return for this request. If you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>WebACL</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>WebACL</code> objects. For the second and subsequent <code>ListWebACLs</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>WebACL</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>WebACL</code> objects that you want AWS WAF to return for this request. If you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>WebACL</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>WebACL</code> objects. For the second and subsequent <code>ListWebACLs</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>WebACL</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.WebACLSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of WebACLSummary objects. The service call response (type Amazon.WAF.Model.ListWebACLsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFWebACLList.html&tocid=Get-WAFWebACLList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFXssMatchSet</name> <description> <para>Invokes the GetXssMatchSet operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFXssMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>XssMatchSet</a> that is specified by <code>XssMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFXssMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to get. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to get. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </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.WAF.Model.XssMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a XssMatchSet object. The service call response (type Amazon.WAF.Model.GetXssMatchSetResponse) 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-WAFXssMatchSet.html&tocid=Get-WAFXssMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFXssMatchSetList</name> <description> <para>Invokes the ListXssMatchSets operation against AWS WAF.</para> </description> <verb>Get</verb> <noun>WAFXssMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>XssMatchSet</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFXssMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <a>XssMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>XssMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <a>XssMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>XssMatchSets</code>. For the second and subsequent <code>ListXssMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>XssMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <a>XssMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>XssMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <a>XssMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>XssMatchSets</code>. For the second and subsequent <code>ListXssMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>XssMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAF.Model.XssMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of XssMatchSetSummary objects. The service call response (type Amazon.WAF.Model.ListXssMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFXssMatchSetList.html&tocid=Get-WAFXssMatchSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFByteMatchSet</name> <description> <para>Invokes the CreateByteMatchSet operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFByteMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>ByteMatchSet</code>. You then use <a>UpdateByteMatchSet</a> to identify the part of a web request that you want AWS WAF to inspect, such as the values of the <code>User-Agent</code> header or the query string. For example, you can create a <code>ByteMatchSet</code> that matches any requests with <code>User-Agent</code> headers that contain the string <code>BadBot</code>. You can then configure AWS WAF to reject those requests. To create and configure a <code>ByteMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateByteMatchSet</code> request. - Submit a <code>CreateByteMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request. - Submit an <a>UpdateByteMatchSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFByteMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>. </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.WAF.Model.CreateByteMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateByteMatchSetResponse 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=New-WAFByteMatchSet.html&tocid=New-WAFByteMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFGeoMatchSet</name> <description> <para>Invokes the CreateGeoMatchSet operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFGeoMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an <a>GeoMatchSet</a>, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an <code>GeoMatchSet</code> that contains those countries and then configure AWS WAF to block the requests. To create and configure a <code>GeoMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateGeoMatchSet</code> request. - Submit a <code>CreateGeoMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateGeoMatchSet</a> request. - Submit an <code>UpdateGeoMatchSetSet</code> request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFGeoMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>GeoMatchSet</a>. You can't change <code>Name</code> after you create the <code>GeoMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>GeoMatchSet</a>. You can't change <code>Name</code> after you create the <code>GeoMatchSet</code>. </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.WAF.Model.CreateGeoMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateGeoMatchSetResponse 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=New-WAFGeoMatchSet.html&tocid=New-WAFGeoMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFIPSet</name> <description> <para>Invokes the CreateIPSet operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFIPSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an <a>IPSet</a>, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an <code>IPSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateIPSet</code> request. - Submit a <code>CreateIPSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. - Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFIPSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>IPSet</a>. You can't change <code>Name</code> after you create the <code>IPSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>IPSet</a>. You can't change <code>Name</code> after you create the <code>IPSet</code>. </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.WAF.Model.CreateIPSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateIPSetResponse 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=New-WAFIPSet.html&tocid=New-WAFIPSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFRateBasedRule</name> <description> <para>Invokes the CreateRateBasedRule operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFRateBasedRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <a>RateBasedRule</a>. The <code>RateBasedRule</code> contains a <code>RateLimit</code>, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The <code>RateBasedRule</code> also contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to count or block if these requests exceed the <code>RateLimit</code>. If you add more than one predicate to a <code>RateBasedRule</code>, a request not only must exceed the <code>RateLimit</code>, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a <code>RateBasedRule</code>: - An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code> - A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header Further, you specify a <code>RateLimit</code> of 15,000. You then add the <code>RateBasedRule</code> to a <code>WebACL</code> and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a <code>RateBasedRule</code>: - A <code>ByteMatchSet</code> with <code>FieldToMatch</code> of <code>URI</code> - A <code>PositionalConstraint</code> of <code>STARTS_WITH</code> - A <code>TargetString</code> of <code>login</code> Further, you specify a <code>RateLimit</code> of 15,000. By adding this <code>RateBasedRule</code> to a <code>WebACL</code>, you could limit requests to your login page without affecting the rest of your site. To create and configure a <code>RateBasedRule</code>, perform the following steps: - Create and update the predicates that you want to include in the rule. For more information, see <a>CreateByteMatchSet</a>, <a>CreateIPSet</a>, and <a>CreateSqlInjectionMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request. - Submit a <code>CreateRateBasedRule</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. - Submit an <code>UpdateRateBasedRule</code> request to specify the predicates that you want to include in the rule. - Create and update a <code>WebACL</code> that contains the <code>RateBasedRule</code>. For more information, see <a>CreateWebACL</a>. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRateBasedRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RateBasedRule</a>. You can't change the name of a <code>RateBasedRule</code> after you create it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>RateBasedRule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>RateBasedRule</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RateKey</name> <description> <para>The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.RateKey</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RateLimit</name> <description> <para>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>. </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="False" 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="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>RateBasedRule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>RateBasedRule</code>. </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 (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RateBasedRule</a>. You can't change the name of a <code>RateBasedRule</code> after you create it. </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="False" position="Named"> <name>RateKey</name> <description> <para>The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.RateKey</parameterValue> <type> <name>Amazon.WAF.RateKey</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RateLimit</name> <description> <para>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.WAF.Model.CreateRateBasedRuleResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateRateBasedRuleResponse 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=New-WAFRateBasedRule.html&tocid=New-WAFRateBasedRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFRegexMatchSet</name> <description> <para>Invokes the CreateRegexMatchSet operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFRegexMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <a>RegexMatchSet</a>. You then use <a>UpdateRegexMatchSet</a> to identify the part of a web request that you want AWS WAF to inspect, such as the values of the <code>User-Agent</code> header or the query string. For example, you can create a <code>RegexMatchSet</code> that contains a <code>RegexMatchTuple</code> that looks for any requests with <code>User-Agent</code> headers that match a <code>RegexPatternSet</code> with pattern <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. To create and configure a <code>RegexMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRegexMatchSet</code> request. - Submit a <code>CreateRegexMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexMatchSet</code> request. - Submit an <a>UpdateRegexMatchSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a <code>RegexPatternSet</code>, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRegexMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RegexMatchSet</a>. You can't change <code>Name</code> after you create a <code>RegexMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RegexMatchSet</a>. You can't change <code>Name</code> after you create a <code>RegexMatchSet</code>. </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.WAF.Model.CreateRegexMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateRegexMatchSetResponse 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=New-WAFRegexMatchSet.html&tocid=New-WAFRegexMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFRegexPatternSet</name> <description> <para>Invokes the CreateRegexPatternSet operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFRegexPatternSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>RegexPatternSet</code>. You then use <a>UpdateRegexPatternSet</a> to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. To create and configure a <code>RegexPatternSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRegexPatternSet</code> request. - Submit a <code>CreateRegexPatternSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexPatternSet</code> request. - Submit an <a>UpdateRegexPatternSet</a> request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRegexPatternSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RegexPatternSet</a>. You can't change <code>Name</code> after you create a <code>RegexPatternSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RegexPatternSet</a>. You can't change <code>Name</code> after you create a <code>RegexPatternSet</code>. </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.WAF.Model.CreateRegexPatternSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateRegexPatternSetResponse 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=New-WAFRegexPatternSet.html&tocid=New-WAFRegexPatternSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFRule</name> <description> <para>Invokes the CreateRule operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>Rule</code>, which contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a <code>Rule</code>: - An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code> - A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to blocks requests that satisfy the <code>Rule</code>. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. To create and configure a <code>Rule</code>, perform the following steps: - Create and update the predicates that you want to include in the <code>Rule</code>. For more information, see <a>CreateByteMatchSet</a>, <a>CreateIPSet</a>, and <a>CreateSqlInjectionMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request. - Submit a <code>CreateRule</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. - Submit an <code>UpdateRule</code> request to specify the predicates that you want to include in the <code>Rule</code>. - Create and update a <code>WebACL</code> that contains the <code>Rule</code>. For more information, see <a>CreateWebACL</a>. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>Rule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>Rule</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>Rule</a>. You can't change the name of a <code>Rule</code> after you create it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>Rule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>Rule</code>. </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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>Rule</a>. You can't change the name of a <code>Rule</code> after you create it. </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.WAF.Model.CreateRuleResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateRuleResponse 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=New-WAFRule.html&tocid=New-WAFRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFSizeConstraintSet</name> <description> <para>Invokes the CreateSizeConstraintSet operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFSizeConstraintSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>SizeConstraintSet</code>. You then use <a>UpdateSizeConstraintSet</a> to identify the part of a web request that you want AWS WAF to check for length, such as the length of the <code>User-Agent</code> header or the length of the query string. For example, you can create a <code>SizeConstraintSet</code> that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a <code>SizeConstraintSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSizeConstraintSet</code> request. - Submit a <code>CreateSizeConstraintSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateSizeConstraintSet</code> request. - Submit an <a>UpdateSizeConstraintSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFSizeConstraintSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>SizeConstraintSet</a>. You can't change <code>Name</code> after you create a <code>SizeConstraintSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>SizeConstraintSet</a>. You can't change <code>Name</code> after you create a <code>SizeConstraintSet</code>. </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.WAF.Model.CreateSizeConstraintSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateSizeConstraintSetResponse 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=New-WAFSizeConstraintSet.html&tocid=New-WAFSizeConstraintSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFSqlInjectionMatchSet</name> <description> <para>Invokes the CreateSqlInjectionMatchSet operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFSqlInjectionMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <a>SqlInjectionMatchSet</a>, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSqlInjectionMatchSet</code> request. - Submit a <code>CreateSqlInjectionMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateSqlInjectionMatchSet</a> request. - Submit an <a>UpdateSqlInjectionMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFSqlInjectionMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description for the <a>SqlInjectionMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>SqlInjectionMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description for the <a>SqlInjectionMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>SqlInjectionMatchSet</code>. </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.WAF.Model.CreateSqlInjectionMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateSqlInjectionMatchSetResponse 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=New-WAFSqlInjectionMatchSet.html&tocid=New-WAFSqlInjectionMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFWebACL</name> <description> <para>Invokes the CreateWebACL operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>WebACL</code>, which contains the <code>Rules</code> that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates <code>Rules</code> in order based on the value of <code>Priority</code> for each <code>Rule</code>. You also specify a default action, either <code>ALLOW</code> or <code>BLOCK</code>. If a web request doesn't match any of the <code>Rules</code> in a <code>WebACL</code>, AWS WAF responds to the request with the default action. To create and configure a <code>WebACL</code>, perform the following steps: - Create and update the <code>ByteMatchSet</code> objects and other predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>. - Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateWebACL</code> request. - Submit a <code>CreateWebACL</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request. - Submit an <a>UpdateWebACL</a> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution. For more information about how to use the AWS WAF API, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>WebACL</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change <code>MetricName</code> after you create the <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>WebACL</a>. You can't change <code>Name</code> after you create the <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultAction_Type</name> <description> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following: - <code>ALLOW</code>: AWS WAF allows requests - <code>BLOCK</code>: AWS WAF blocks requests - <code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.WafActionType</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" position="Named"> <name>DefaultAction_Type</name> <description> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following: - <code>ALLOW</code>: AWS WAF allows requests - <code>BLOCK</code>: AWS WAF blocks requests - <code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.WafActionType</parameterValue> <type> <name>Amazon.WAF.WafActionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>WebACL</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change <code>MetricName</code> after you create the <code>WebACL</code>. </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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>WebACL</a>. You can't change <code>Name</code> after you create the <code>WebACL</code>. </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.WAF.Model.CreateWebACLResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateWebACLResponse 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=New-WAFWebACL.html&tocid=New-WAFWebACL</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>New-WAFXssMatchSet</name> <description> <para>Invokes the CreateXssMatchSet operation against AWS WAF.</para> </description> <verb>New</verb> <noun>WAFXssMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an <a>XssMatchSet</a>, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an <code>XssMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateXssMatchSet</code> request. - Submit a <code>CreateXssMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateXssMatchSet</a> request. - Submit an <a>UpdateXssMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFXssMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description for the <a>XssMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>XssMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description for the <a>XssMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>XssMatchSet</code>. </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.WAF.Model.CreateXssMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAF.Model.CreateXssMatchSetResponse 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=New-WAFXssMatchSet.html&tocid=New-WAFXssMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFByteMatchSet</name> <description> <para>Invokes the DeleteByteMatchSet operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFByteMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>ByteMatchSet</a>. You can't delete a <code>ByteMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>ByteMatchTuple</a> objects (any filters). If you just want to remove a <code>ByteMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>ByteMatchSet</code>, perform the following steps: - Update the <code>ByteMatchSet</code> to remove filters, if any. For more information, see <a>UpdateByteMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteByteMatchSet</code> request. - Submit a <code>DeleteByteMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFByteMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to delete. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to delete. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </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="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteByteMatchSetResponse) 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=Remove-WAFByteMatchSet.html&tocid=Remove-WAFByteMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFGeoMatchSet</name> <description> <para>Invokes the DeleteGeoMatchSet operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFGeoMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>GeoMatchSet</a>. You can't delete a <code>GeoMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any countries. If you just want to remove a <code>GeoMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>GeoMatchSet</code> from AWS WAF, perform the following steps: - Update the <code>GeoMatchSet</code> to remove any countries. For more information, see <a>UpdateGeoMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteGeoMatchSet</code> request. - Submit a <code>DeleteGeoMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFGeoMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetID</code> of the <a>GeoMatchSet</a> that you want to delete. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetID</code> of the <a>GeoMatchSet</a> that you want to delete. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteGeoMatchSetResponse) 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=Remove-WAFGeoMatchSet.html&tocid=Remove-WAFGeoMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFIPSet</name> <description> <para>Invokes the DeleteIPSet operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFIPSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes an <a>IPSet</a>. You can't delete an <code>IPSet</code> if it's still used in any <code>Rules</code> or if it still includes any IP addresses. If you just want to remove an <code>IPSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete an <code>IPSet</code> from AWS WAF, perform the following steps: - Update the <code>IPSet</code> to remove IP address ranges, if any. For more information, see <a>UpdateIPSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteIPSet</code> request. - Submit a <code>DeleteIPSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFIPSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to delete. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to delete. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteIPSetResponse) 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=Remove-WAFIPSet.html&tocid=Remove-WAFIPSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFRateBasedRule</name> <description> <para>Invokes the DeleteRateBasedRule operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFRateBasedRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>RateBasedRule</a>. You can't delete a rule if it's still used in any <code>WebACL</code> objects or if it still includes any predicates, such as <code>ByteMatchSet</code> objects. If you just want to remove a rule from a <code>WebACL</code>, use <a>UpdateWebACL</a>. To permanently delete a <code>RateBasedRule</code> from AWS WAF, perform the following steps: - Update the <code>RateBasedRule</code> to remove predicates, if any. For more information, see <a>UpdateRateBasedRule</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRateBasedRule</code> request. - Submit a <code>DeleteRateBasedRule</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRateBasedRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteRateBasedRuleResponse) 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=Remove-WAFRateBasedRule.html&tocid=Remove-WAFRateBasedRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFRegexMatchSet</name> <description> <para>Invokes the DeleteRegexMatchSet operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFRegexMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>RegexMatchSet</a>. You can't delete a <code>RegexMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any <code>RegexMatchTuples</code> objects (any filters). If you just want to remove a <code>RegexMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>RegexMatchSet</code>, perform the following steps: - Update the <code>RegexMatchSet</code> to remove filters, if any. For more information, see <a>UpdateRegexMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRegexMatchSet</code> request. - Submit a <code>DeleteRegexMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRegexMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to delete. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to delete. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteRegexMatchSetResponse) 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=Remove-WAFRegexMatchSet.html&tocid=Remove-WAFRegexMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFRegexPatternSet</name> <description> <para>Invokes the DeleteRegexPatternSet operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFRegexPatternSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>RegexPatternSet</a>. You can't delete a <code>RegexPatternSet</code> if it's still used in any <code>RegexMatchSet</code> or if the <code>RegexPatternSet</code> is not empty. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRegexPatternSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to delete. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to delete. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteRegexPatternSetResponse) 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=Remove-WAFRegexPatternSet.html&tocid=Remove-WAFRegexPatternSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFRule</name> <description> <para>Invokes the DeleteRule operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>Rule</a>. You can't delete a <code>Rule</code> if it's still used in any <code>WebACL</code> objects or if it still includes any predicates, such as <code>ByteMatchSet</code> objects. If you just want to remove a <code>Rule</code> from a <code>WebACL</code>, use <a>UpdateWebACL</a>. To permanently delete a <code>Rule</code> from AWS WAF, perform the following steps: - Update the <code>Rule</code> to remove predicates, if any. For more information, see <a>UpdateRule</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRule</code> request. - Submit a <code>DeleteRule</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteRuleResponse) 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=Remove-WAFRule.html&tocid=Remove-WAFRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFSizeConstraintSet</name> <description> <para>Invokes the DeleteSizeConstraintSet operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFSizeConstraintSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>SizeConstraintSet</a>. You can't delete a <code>SizeConstraintSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>SizeConstraint</a> objects (any filters). If you just want to remove a <code>SizeConstraintSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>SizeConstraintSet</code>, perform the following steps: - Update the <code>SizeConstraintSet</code> to remove filters, if any. For more information, see <a>UpdateSizeConstraintSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSizeConstraintSet</code> request. - Submit a <code>DeleteSizeConstraintSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFSizeConstraintSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to delete. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to delete. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteSizeConstraintSetResponse) 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=Remove-WAFSizeConstraintSet.html&tocid=Remove-WAFSizeConstraintSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFSqlInjectionMatchSet</name> <description> <para>Invokes the DeleteSqlInjectionMatchSet operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFSqlInjectionMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>SqlInjectionMatchSet</a>. You can't delete a <code>SqlInjectionMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>SqlInjectionMatchTuple</a> objects. If you just want to remove a <code>SqlInjectionMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>SqlInjectionMatchSet</code> from AWS WAF, perform the following steps: - Update the <code>SqlInjectionMatchSet</code> to remove filters, if any. For more information, see <a>UpdateSqlInjectionMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSqlInjectionMatchSet</code> request. - Submit a <code>DeleteSqlInjectionMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFSqlInjectionMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to delete. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to delete. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteSqlInjectionMatchSetResponse) 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=Remove-WAFSqlInjectionMatchSet.html&tocid=Remove-WAFSqlInjectionMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFWebACL</name> <description> <para>Invokes the DeleteWebACL operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>WebACL</a>. You can't delete a <code>WebACL</code> if it still contains any <code>Rules</code>. To delete a <code>WebACL</code>, perform the following steps: - Update the <code>WebACL</code> to remove <code>Rules</code>, if any. For more information, see <a>UpdateWebACL</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteWebACL</code> request. - Submit a <code>DeleteWebACL</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to delete. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to delete. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteWebACLResponse) 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=Remove-WAFWebACL.html&tocid=Remove-WAFWebACL</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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-WAFXssMatchSet</name> <description> <para>Invokes the DeleteXssMatchSet operation against AWS WAF.</para> </description> <verb>Remove</verb> <noun>WAFXssMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes an <a>XssMatchSet</a>. You can't delete an <code>XssMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>XssMatchTuple</a> objects. If you just want to remove an <code>XssMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete an <code>XssMatchSet</code> from AWS WAF, perform the following steps: - Update the <code>XssMatchSet</code> to remove filters, if any. For more information, see <a>UpdateXssMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteXssMatchSet</code> request. - Submit a <code>DeleteXssMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFXssMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to delete. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to delete. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.DeleteXssMatchSetResponse) 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=Remove-WAFXssMatchSet.html&tocid=Remove-WAFXssMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFByteMatchSet</name> <description> <para>Invokes the UpdateByteMatchSet operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFByteMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>ByteMatchTuple</a> objects (filters) in a <a>ByteMatchSet</a>. For each <code>ByteMatchTuple</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change a <code>ByteMatchSetUpdate</code> object, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the <code>User-Agent</code> header. - The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see <code>TargetString</code> in the <a>ByteMatchTuple</a> data type. - Where to look, such as at the beginning or the end of a query string. - Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a <code>ByteMatchSetUpdate</code> object that matches web requests in which <code>User-Agent</code> headers contain the string <code>BadBot</code>. You can then configure AWS WAF to block those requests. To create and configure a <code>ByteMatchSet</code>, perform the following steps: - Create a <code>ByteMatchSet.</code> For more information, see <a>CreateByteMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request. - Submit an <code>UpdateByteMatchSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFByteMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to update. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>ByteMatchSetUpdate</code> objects that you want to insert into or delete from a <a>ByteMatchSet</a>. For more information, see the applicable data types: - <a>ByteMatchSetUpdate</a>: Contains <code>Action</code> and <code>ByteMatchTuple</code> - <a>ByteMatchTuple</a>: Contains <code>FieldToMatch</code>, <code>PositionalConstraint</code>, <code>TargetString</code>, and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.ByteMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to update. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </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="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>ByteMatchSetUpdate</code> objects that you want to insert into or delete from a <a>ByteMatchSet</a>. For more information, see the applicable data types: - <a>ByteMatchSetUpdate</a>: Contains <code>Action</code> and <code>ByteMatchTuple</code> - <a>ByteMatchTuple</a>: Contains <code>FieldToMatch</code>, <code>PositionalConstraint</code>, <code>TargetString</code>, and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.ByteMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.ByteMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateByteMatchSetResponse) 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=Update-WAFByteMatchSet.html&tocid=Update-WAFByteMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFGeoMatchSet</name> <description> <para>Invokes the UpdateGeoMatchSet operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFGeoMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>GeoMatchConstraint</a> objects in an <code>GeoMatchSet</code>. For each <code>GeoMatchConstraint</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change an <code>GeoMatchConstraint</code> object, you delete the existing object and add a new one. - The <code>Type</code>. The only valid value for <code>Type</code> is <code>Country</code>. - The <code>Value</code>, which is a two character code for the country to add to the <code>GeoMatchConstraint</code> object. Valid codes are listed in <a>GeoMatchConstraint$Value</a>. To create and configure an <code>GeoMatchSet</code>, perform the following steps: - Submit a <a>CreateGeoMatchSet</a> request. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateGeoMatchSet</a> request. - Submit an <code>UpdateGeoMatchSet</code> request to specify the country that you want AWS WAF to watch for. When you update an <code>GeoMatchSet</code>, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFGeoMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to update. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>GeoMatchSetUpdate</code> objects that you want to insert into or delete from an <a>GeoMatchSet</a>. For more information, see the applicable data types: - <a>GeoMatchSetUpdate</a>: Contains <code>Action</code> and <code>GeoMatchConstraint</code> - <a>GeoMatchConstraint</a>: Contains <code>Type</code> and <code>Value</code> You can have only one <code>Type</code> and <code>Value</code> per <code>GeoMatchConstraint</code>. To add multiple countries, include multiple <code>GeoMatchSetUpdate</code> objects in your request. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.GeoMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to update. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>GeoMatchSetUpdate</code> objects that you want to insert into or delete from an <a>GeoMatchSet</a>. For more information, see the applicable data types: - <a>GeoMatchSetUpdate</a>: Contains <code>Action</code> and <code>GeoMatchConstraint</code> - <a>GeoMatchConstraint</a>: Contains <code>Type</code> and <code>Value</code> You can have only one <code>Type</code> and <code>Value</code> per <code>GeoMatchConstraint</code>. To add multiple countries, include multiple <code>GeoMatchSetUpdate</code> objects in your request. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.GeoMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.GeoMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateGeoMatchSetResponse) 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=Update-WAFGeoMatchSet.html&tocid=Update-WAFGeoMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFIPSet</name> <description> <para>Invokes the UpdateIPSet operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFIPSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>IPSetDescriptor</a> objects in an <code>IPSet</code>. For each <code>IPSetDescriptor</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code> object, you delete the existing object and add a new one. - The IP address version, <code>IPv4</code> or <code>IPv6</code>. - The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code> (for the individual IP address <code>192.0.2.44</code>). AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. IPv6 addresses can be represented using any of the following formats: - 1111:0000:0000:0000:0000:0000:0000:0111/128 - 1111:0:0:0:0:0:0:0111/128 - 1111::0111/128 - 1111::111/128 You use an <code>IPSet</code> to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an <code>IPSet</code>, perform the following steps: - Submit a <a>CreateIPSet</a> request. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. - Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for. When you update an <code>IPSet</code>, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFIPSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to update. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>IPSetUpdate</code> objects that you want to insert into or delete from an <a>IPSet</a>. For more information, see the applicable data types: - <a>IPSetUpdate</a>: Contains <code>Action</code> and <code>IPSetDescriptor</code> - <a>IPSetDescriptor</a>: Contains <code>Type</code> and <code>Value</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.IPSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to update. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>IPSetUpdate</code> objects that you want to insert into or delete from an <a>IPSet</a>. For more information, see the applicable data types: - <a>IPSetUpdate</a>: Contains <code>Action</code> and <code>IPSetDescriptor</code> - <a>IPSetDescriptor</a>: Contains <code>Type</code> and <code>Value</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.IPSetUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.IPSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateIPSetResponse) 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=Update-WAFIPSet.html&tocid=Update-WAFIPSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFRateBasedRule</name> <description> <para>Invokes the UpdateRateBasedRule operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFRateBasedRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>Predicate</a> objects in a rule and updates the <code>RateLimit</code> in the rule. Each <code>Predicate</code> object identifies a predicate, such as a <a>ByteMatchSet</a> or an <a>IPSet</a>, that specifies the web requests that you want to block or count. The <code>RateLimit</code> specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a <code>RateBasedRule</code>, a request must match all the predicates and exceed the <code>RateLimit</code> to be counted or blocked. For example, suppose you add the following to a <code>RateBasedRule</code>: - An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code> - A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header Further, you specify a <code>RateLimit</code> of 15,000. You then add the <code>RateBasedRule</code> to a <code>WebACL</code> and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a <code>RateBasedRule</code>: - A <code>ByteMatchSet</code> with <code>FieldToMatch</code> of <code>URI</code> - A <code>PositionalConstraint</code> of <code>STARTS_WITH</code> - A <code>TargetString</code> of <code>login</code> Further, you specify a <code>RateLimit</code> of 15,000. By adding this <code>RateBasedRule</code> to a <code>WebACL</code>, you could limit requests to your login page without affecting the rest of your site. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRateBasedRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <code>RateBasedRule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRateBasedRule</code> and by <a>ListRateBasedRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RateLimit</name> <description> <para>The maximum number of requests, which have an identical value in the field specified by the <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>RateBasedRule</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.RuleUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>RateLimit</name> <description> <para>The maximum number of requests, which have an identical value in the field specified by the <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <code>RateBasedRule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRateBasedRule</code> and by <a>ListRateBasedRules</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>RateBasedRule</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.RuleUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.RuleUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateRateBasedRuleResponse) 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=Update-WAFRateBasedRule.html&tocid=Update-WAFRateBasedRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFRegexMatchSet</name> <description> <para>Invokes the UpdateRegexMatchSet operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFRegexMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>RegexMatchSetUpdate</a> objects (filters) in a <a>RegexMatchSet</a>. For each <code>RegexMatchSetUpdate</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change a <code>RegexMatchSetUpdate</code> object, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the <code>User-Agent</code> header. - The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see <a>RegexPatternSet</a>. - Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a <code>RegexPatternSet</code> that matches any requests with <code>User-Agent</code> headers that contain the string <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. To create and configure a <code>RegexMatchSet</code>, perform the following steps: - Create a <code>RegexMatchSet.</code> For more information, see <a>CreateRegexMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexMatchSet</code> request. - Submit an <code>UpdateRegexMatchSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the <code>RegexPatternSet</code> that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRegexMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to update. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RegexMatchSetUpdate</code> objects that you want to insert into or delete from a <a>RegexMatchSet</a>. For more information, see <a>RegexMatchTuple</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.RegexMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to update. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RegexMatchSetUpdate</code> objects that you want to insert into or delete from a <a>RegexMatchSet</a>. For more information, see <a>RegexMatchTuple</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.RegexMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.RegexMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateRegexMatchSetResponse) 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=Update-WAFRegexMatchSet.html&tocid=Update-WAFRegexMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFRegexPatternSet</name> <description> <para>Invokes the UpdateRegexPatternSet operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFRegexPatternSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>RegexMatchSetUpdate</a> objects (filters) in a <a>RegexPatternSet</a>. For each <code>RegexPatternSet</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change a <code>RegexPatternSet</code> object, you delete the existing object and add a new one. - The regular expression pattern that you want AWS WAF to look for. For more information, see <a>RegexPatternSet</a>. For example, you can create a <code>RegexPatternString</code> such as <code>B[a@]dB[o0]t</code>. AWS WAF will match this <code>RegexPatternString</code> to: - BadBot - BadB0t - B@dBot - B@dB0t To create and configure a <code>RegexPatternSet</code>, perform the following steps: - Create a <code>RegexPatternSet.</code> For more information, see <a>CreateRegexPatternSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexPatternSet</code> request. - Submit an <code>UpdateRegexPatternSet</code> request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRegexPatternSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to update. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RegexPatternSetUpdate</code> objects that you want to insert into or delete from a <a>RegexPatternSet</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.RegexPatternSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to update. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RegexPatternSetUpdate</code> objects that you want to insert into or delete from a <a>RegexPatternSet</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.RegexPatternSetUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.RegexPatternSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateRegexPatternSetResponse) 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=Update-WAFRegexPatternSet.html&tocid=Update-WAFRegexPatternSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFRule</name> <description> <para>Invokes the UpdateRule operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>Predicate</a> objects in a <code>Rule</code>. Each <code>Predicate</code> object identifies a predicate, such as a <a>ByteMatchSet</a> or an <a>IPSet</a>, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a <code>Rule</code>: - A <code>ByteMatchSet</code> that matches the value <code>BadBot</code> in the <code>User-Agent</code> header - An <code>IPSet</code> that matches the IP address <code>192.0.2.44</code> You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to block requests that satisfy the <code>Rule</code>. For a request to be blocked, the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code><i>and</i> the request must originate from the IP address 192.0.2.44. To create and configure a <code>Rule</code>, perform the following steps: - Create and update the predicates that you want to include in the <code>Rule</code>. - Create the <code>Rule</code>. See <a>CreateRule</a>. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. - Submit an <code>UpdateRule</code> request to add predicates to the <code>Rule</code>. - Create and update a <code>WebACL</code> that contains the <code>Rule</code>. See <a>CreateWebACL</a>. If you want to replace one <code>ByteMatchSet</code> or <code>IPSet</code> with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <code>Rule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRule</code> and by <a>ListRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>Rule</a>. For more information, see the applicable data types: - <a>RuleUpdate</a>: Contains <code>Action</code> and <code>Predicate</code> - <a>Predicate</a>: Contains <code>DataId</code>, <code>Negated</code>, and <code>Type</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.RuleUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <code>Rule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRule</code> and by <a>ListRules</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>Rule</a>. For more information, see the applicable data types: - <a>RuleUpdate</a>: Contains <code>Action</code> and <code>Predicate</code> - <a>Predicate</a>: Contains <code>DataId</code>, <code>Negated</code>, and <code>Type</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.RuleUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.RuleUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateRuleResponse) 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=Update-WAFRule.html&tocid=Update-WAFRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFSizeConstraintSet</name> <description> <para>Invokes the UpdateSizeConstraintSet operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFSizeConstraintSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>SizeConstraint</a> objects (filters) in a <a>SizeConstraintSet</a>. For each <code>SizeConstraint</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change a <code>SizeConstraintSetUpdate</code> object, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the <code>User-Agent</code> header. - Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first <code>8192</code> bytes of your request to AWS WAF. - A <code>ComparisonOperator</code> used for evaluating the selected part of the request against the specified <code>Size</code>, such as equals, greater than, less than, and so on. - The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a <code>SizeConstraintSetUpdate</code> object that matches web requests in which the length of the <code>User-Agent</code> header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a <code>SizeConstraintSet</code>, perform the following steps: - Create a <code>SizeConstraintSet.</code> For more information, see <a>CreateSizeConstraintSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateSizeConstraintSet</code> request. - Submit an <code>UpdateSizeConstraintSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFSizeConstraintSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to update. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>SizeConstraintSetUpdate</code> objects that you want to insert into or delete from a <a>SizeConstraintSet</a>. For more information, see the applicable data types: - <a>SizeConstraintSetUpdate</a>: Contains <code>Action</code> and <code>SizeConstraint</code> - <a>SizeConstraint</a>: Contains <code>FieldToMatch</code>, <code>TextTransformation</code>, <code>ComparisonOperator</code>, and <code>Size</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.SizeConstraintSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to update. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>SizeConstraintSetUpdate</code> objects that you want to insert into or delete from a <a>SizeConstraintSet</a>. For more information, see the applicable data types: - <a>SizeConstraintSetUpdate</a>: Contains <code>Action</code> and <code>SizeConstraint</code> - <a>SizeConstraint</a>: Contains <code>FieldToMatch</code>, <code>TextTransformation</code>, <code>ComparisonOperator</code>, and <code>Size</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.SizeConstraintSetUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.SizeConstraintSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateSizeConstraintSetResponse) 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=Update-WAFSizeConstraintSet.html&tocid=Update-WAFSizeConstraintSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFSqlInjectionMatchSet</name> <description> <para>Invokes the UpdateSqlInjectionMatchSet operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFSqlInjectionMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>SqlInjectionMatchTuple</a> objects (filters) in a <a>SqlInjectionMatchSet</a>. For each <code>SqlInjectionMatchTuple</code> object, you specify the following values: - <code>Action</code>: Whether to insert the object into or delete the object from the array. To change a <code>SqlInjectionMatchTuple</code>, you delete the existing object and add a new one. - <code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header. - <code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You use <code>SqlInjectionMatchSet</code> objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a <code>SqlInjectionMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps: - Submit a <a>CreateSqlInjectionMatchSet</a> request. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. - Submit an <code>UpdateSqlInjectionMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFSqlInjectionMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <code>SqlInjectionMatchSet</code> that you want to update. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>SqlInjectionMatchSetUpdate</code> objects that you want to insert into or delete from a <a>SqlInjectionMatchSet</a>. For more information, see the applicable data types: - <a>SqlInjectionMatchSetUpdate</a>: Contains <code>Action</code> and <code>SqlInjectionMatchTuple</code> - <a>SqlInjectionMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.SqlInjectionMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <code>SqlInjectionMatchSet</code> that you want to update. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>SqlInjectionMatchSetUpdate</code> objects that you want to insert into or delete from a <a>SqlInjectionMatchSet</a>. For more information, see the applicable data types: - <a>SqlInjectionMatchSetUpdate</a>: Contains <code>Action</code> and <code>SqlInjectionMatchTuple</code> - <a>SqlInjectionMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.SqlInjectionMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.SqlInjectionMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateSqlInjectionMatchSetResponse) 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=Update-WAFSqlInjectionMatchSet.html&tocid=Update-WAFSqlInjectionMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFWebACL</name> <description> <para>Invokes the UpdateWebACL operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>ActivatedRule</a> objects in a <code>WebACL</code>. Each <code>Rule</code> identifies web requests that you want to allow, block, or count. When you update a <code>WebACL</code>, you specify the following values: - A default action for the <code>WebACL</code>, either <code>ALLOW</code> or <code>BLOCK</code>. AWS WAF performs the default action if a request doesn't match the criteria in any of the <code>Rules</code> in a <code>WebACL</code>. - The <code>Rules</code> that you want to add and/or delete. If you want to replace one <code>Rule</code> with another, you delete the existing <code>Rule</code> and add the new one. - For each <code>Rule</code>, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the <code>Rule</code>. - The order in which you want AWS WAF to evaluate the <code>Rules</code> in a <code>WebACL</code>. If you add more than one <code>Rule</code> to a <code>WebACL</code>, AWS WAF evaluates each request against the <code>Rules</code> in order based on the value of <code>Priority</code>. (The <code>Rule</code> that has the lowest value for <code>Priority</code> is evaluated first.) When a web request matches all of the predicates (such as <code>ByteMatchSets</code> and <code>IPSets</code>) in a <code>Rule</code>, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining <code>Rules</code> in the <code>WebACL</code>, if any. To create and configure a <code>WebACL</code>, perform the following steps: - Create and update the predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>. - Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>. - Create a <code>WebACL</code>. See <a>CreateWebACL</a>. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request. - Submit an <code>UpdateWebACL</code> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the <a>UpdateWebACL</a> request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to update. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultAction_Type</name> <description> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following: - <code>ALLOW</code>: AWS WAF allows requests - <code>BLOCK</code>: AWS WAF blocks requests - <code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.WafActionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of updates to make to the <a>WebACL</a>. An array of <code>WebACLUpdate</code> objects that you want to insert into or delete from a <a>WebACL</a>. For more information, see the applicable data types: - <a>WebACLUpdate</a>: Contains <code>Action</code> and <code>ActivatedRule</code> - <a>ActivatedRule</a>: Contains <code>Action</code>, <code>Priority</code>, <code>RuleId</code>, and <code>Type</code> - <a>WafAction</a>: Contains <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.WebACLUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" position="Named"> <name>DefaultAction_Type</name> <description> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following: - <code>ALLOW</code>: AWS WAF allows requests - <code>BLOCK</code>: AWS WAF blocks requests - <code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.WafActionType</parameterValue> <type> <name>Amazon.WAF.WafActionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Update</name> <description> <para>An array of updates to make to the <a>WebACL</a>. An array of <code>WebACLUpdate</code> objects that you want to insert into or delete from a <a>WebACL</a>. For more information, see the applicable data types: - <a>WebACLUpdate</a>: Contains <code>Action</code> and <code>ActivatedRule</code> - <a>ActivatedRule</a>: Contains <code>Action</code>, <code>Priority</code>, <code>RuleId</code>, and <code>Type</code> - <a>WafAction</a>: Contains <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.WebACLUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.WebACLUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to update. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateWebACLResponse) 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=Update-WAFWebACL.html&tocid=Update-WAFWebACL</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Update-WAFXssMatchSet</name> <description> <para>Invokes the UpdateXssMatchSet operation against AWS WAF.</para> </description> <verb>Update</verb> <noun>WAFXssMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>XssMatchTuple</a> objects (filters) in an <a>XssMatchSet</a>. For each <code>XssMatchTuple</code> object, you specify the following values: - <code>Action</code>: Whether to insert the object into or delete the object from the array. To change a <code>XssMatchTuple</code>, you delete the existing object and add a new one. - <code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header. - <code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You use <code>XssMatchSet</code> objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an <code>XssMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an <code>XssMatchSet</code>, perform the following steps: - Submit a <a>CreateXssMatchSet</a> request. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. - Submit an <code>UpdateXssMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFXssMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>XssMatchSetUpdate</code> objects that you want to insert into or delete from a <a>XssMatchSet</a>. For more information, see the applicable data types: - <a>XssMatchSetUpdate</a>: Contains <code>Action</code> and <code>XssMatchTuple</code> - <a>XssMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.XssMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <code>XssMatchSet</code> that you want to update. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>XssMatchSetUpdate</code> objects that you want to insert into or delete from a <a>XssMatchSet</a>. For more information, see the applicable data types: - <a>XssMatchSetUpdate</a>: Contains <code>Action</code> and <code>XssMatchTuple</code> - <a>XssMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAF.Model.XssMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAF.Model.XssMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <code>XssMatchSet</code> that you want to update. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAF.Model.UpdateXssMatchSetResponse) 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=Update-WAFXssMatchSet.html&tocid=Update-WAFXssMatchSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/developerguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/waf/latest/APIReference/</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>Get-WAFRByteMatchSet</name> <description> <para>Invokes the GetByteMatchSet operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRByteMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>ByteMatchSet</a> specified by <code>ByteMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRByteMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to get. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to get. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </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.WAFRegional.Model.ByteMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ByteMatchSet object. The service call response (type Amazon.WAFRegional.Model.GetByteMatchSetResponse) 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-WAFRByteMatchSet.html&tocid=Get-WAFRByteMatchSet</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>Get-WAFRByteMatchSetList</name> <description> <para>Invokes the ListByteMatchSets operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRByteMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>ByteMatchSetSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRByteMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>ByteMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>ByteMatchSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>ByteMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>ByteMatchSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListByteMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ByteMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>ByteMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>ByteMatchSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>ByteMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>ByteMatchSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListByteMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ByteMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.ByteMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ByteMatchSetSummary objects. The service call response (type Amazon.WAFRegional.Model.ListByteMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRByteMatchSetList.html&tocid=Get-WAFRByteMatchSetList</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>Get-WAFRChangeToken</name> <description> <para>Invokes the GetChangeToken operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRChangeToken</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a <code>GetChangeToken</code> request and then submits a second <code>GetChangeToken</code> request before submitting a create, update, or delete request, the second <code>GetChangeToken</code> request returns the same value as the first <code>GetChangeToken</code> request. When you use a change token in a create, update, or delete request, the status of the change token changes to <code>PENDING</code>, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use <code>GetChangeTokenStatus</code> to determine the status of your change token. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRChangeToken</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.GetChangeTokenResponse) 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-WAFRChangeToken.html&tocid=Get-WAFRChangeToken</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>Get-WAFRChangeTokenStatus</name> <description> <para>Invokes the GetChangeTokenStatus operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRChangeTokenStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the status of a <code>ChangeToken</code> that you got by calling <a>GetChangeToken</a>. <code>ChangeTokenStatus</code> is one of the following values: - <code>PROVISIONED</code>: You requested the change token by calling <code>GetChangeToken</code>, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. - <code>PENDING</code>: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. - <code>IN_SYNC</code>: Propagation is complete. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRChangeTokenStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The change token for which you want to get the status. This change token was previously returned in the <code>GetChangeToken</code> response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The change token for which you want to get the status. This change token was previously returned in the <code>GetChangeToken</code> response. </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.WAFRegional.ChangeTokenStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ChangeTokenStatus object. The service call response (type Amazon.WAFRegional.Model.GetChangeTokenStatusResponse) 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-WAFRChangeTokenStatus.html&tocid=Get-WAFRChangeTokenStatus</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>Get-WAFRGeoMatchSet</name> <description> <para>Invokes the GetGeoMatchSet operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRGeoMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>GeoMatchSet</a> that is specified by <code>GeoMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRGeoMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to get. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to get. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </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.WAFRegional.Model.GeoMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a GeoMatchSet object. The service call response (type Amazon.WAFRegional.Model.GetGeoMatchSetResponse) 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-WAFRGeoMatchSet.html&tocid=Get-WAFRGeoMatchSet</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>Get-WAFRGeoMatchSetList</name> <description> <para>Invokes the ListGeoMatchSets operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRGeoMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>GeoMatchSetSummary</a> objects in the response.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRGeoMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>GeoMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>GeoMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>GeoMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>GeoMatchSet</code>s than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>GeoMatchSet</code> objects. For the second and subsequent <code>ListGeoMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>GeoMatchSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>GeoMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>GeoMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>GeoMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>GeoMatchSet</code>s than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>GeoMatchSet</code> objects. For the second and subsequent <code>ListGeoMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>GeoMatchSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.GeoMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of GeoMatchSetSummary objects. The service call response (type Amazon.WAFRegional.Model.ListGeoMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRGeoMatchSetList.html&tocid=Get-WAFRGeoMatchSetList</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>Get-WAFRIPSet</name> <description> <para>Invokes the GetIPSet operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRIPSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>IPSet</a> that is specified by <code>IPSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRIPSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to get. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to get. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </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.WAFRegional.Model.IPSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a IPSet object. The service call response (type Amazon.WAFRegional.Model.GetIPSetResponse) 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-WAFRIPSet.html&tocid=Get-WAFRIPSet</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>Get-WAFRIPSetList</name> <description> <para>Invokes the ListIPSets operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRIPSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>IPSetSummary</a> objects in the response.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRIPSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>IPSet</code> objects that you want AWS WAF to return for this request. If you have more <code>IPSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>IPSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>IPSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>IPSet</code> objects that you want AWS WAF to return for this request. If you have more <code>IPSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>IPSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>IPSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.IPSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of IPSetSummary objects. The service call response (type Amazon.WAFRegional.Model.ListIPSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRIPSetList.html&tocid=Get-WAFRIPSetList</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>Get-WAFRRateBasedRule</name> <description> <para>Invokes the GetRateBasedRule operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRateBasedRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>RateBasedRule</a> that is specified by the <code>RuleId</code> that you included in the <code>GetRateBasedRule</code> request. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRateBasedRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </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.WAFRegional.Model.RateBasedRule</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RateBasedRule object. The service call response (type Amazon.WAFRegional.Model.GetRateBasedRuleResponse) 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-WAFRRateBasedRule.html&tocid=Get-WAFRRateBasedRule</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>Get-WAFRRateBasedRuleList</name> <description> <para>Invokes the ListRateBasedRules operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRateBasedRuleList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>RuleSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRateBasedRuleList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRateBasedRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRateBasedRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.RuleSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RuleSummary objects. The service call response (type Amazon.WAFRegional.Model.ListRateBasedRulesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRRateBasedRuleList.html&tocid=Get-WAFRRateBasedRuleList</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>Get-WAFRRateBasedRuleManagedKey</name> <description> <para>Invokes the GetRateBasedRuleManagedKeys operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRateBasedRuleManagedKey</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of IP addresses currently being blocked by the <a>RateBasedRule</a> that is specified by the <code>RuleId</code>. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRateBasedRuleManagedKey</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> for which you want to get a list of <code>ManagedKeys</code>. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>A null value and not currently used. Do not include this in your request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>A null value and not currently used. Do not include this in your request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> for which you want to get a list of <code>ManagedKeys</code>. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.WAFRegional.Model.GetRateBasedRuleManagedKeysResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRRateBasedRuleManagedKey.html&tocid=Get-WAFRRateBasedRuleManagedKey</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>Get-WAFRRegexMatchSet</name> <description> <para>Invokes the GetRegexMatchSet operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRegexMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>RegexMatchSet</a> specified by <code>RegexMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRegexMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to get. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to get. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </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.WAFRegional.Model.RegexMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RegexMatchSet object. The service call response (type Amazon.WAFRegional.Model.GetRegexMatchSetResponse) 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-WAFRRegexMatchSet.html&tocid=Get-WAFRRegexMatchSet</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>Get-WAFRRegexMatchSetList</name> <description> <para>Invokes the ListRegexMatchSets operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRegexMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>RegexMatchSetSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRegexMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>RegexMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexMatchSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListRegexMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexMatchSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>RegexMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexMatchSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexMatchSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListRegexMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexMatchSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.RegexMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RegexMatchSetSummary objects. The service call response (type Amazon.WAFRegional.Model.ListRegexMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRRegexMatchSetList.html&tocid=Get-WAFRRegexMatchSetList</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>Get-WAFRRegexPatternSet</name> <description> <para>Invokes the GetRegexPatternSet operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRegexPatternSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>RegexPatternSet</a> specified by <code>RegexPatternSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRegexPatternSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to get. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to get. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </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.WAFRegional.Model.RegexPatternSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RegexPatternSet object. The service call response (type Amazon.WAFRegional.Model.GetRegexPatternSetResponse) 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-WAFRRegexPatternSet.html&tocid=Get-WAFRRegexPatternSet</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>Get-WAFRRegexPatternSetList</name> <description> <para>Invokes the ListRegexPatternSets operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRegexPatternSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>RegexPatternSetSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRegexPatternSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>RegexPatternSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexPatternSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexPatternSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexPatternSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>RegexPatternSet</code> objects. For the second and subsequent <code>ListRegexPatternSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexPatternSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>RegexPatternSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexPatternSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexPatternSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexPatternSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>RegexPatternSet</code> objects. For the second and subsequent <code>ListRegexPatternSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexPatternSet</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.RegexPatternSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RegexPatternSetSummary objects. The service call response (type Amazon.WAFRegional.Model.ListRegexPatternSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRRegexPatternSetList.html&tocid=Get-WAFRRegexPatternSetList</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>Get-WAFRResourceForWebACLList</name> <description> <para>Invokes the ListResourcesForWebACL operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRResourceForWebACLList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of resources associated with the specified web ACL. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRResourceForWebACLList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The unique identifier (ID) of the web ACL for which to list the associated resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The unique identifier (ID) of the web ACL for which to list the associated resources. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.WAFRegional.Model.ListResourcesForWebACLResponse) 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-WAFRResourceForWebACLList.html&tocid=Get-WAFRResourceForWebACLList</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>Get-WAFRRule</name> <description> <para>Invokes the GetRule operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>Rule</a> that is specified by the <code>RuleId</code> that you included in the <code>GetRule</code> request. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>. </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.WAFRegional.Model.Rule</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Rule object. The service call response (type Amazon.WAFRegional.Model.GetRuleResponse) 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-WAFRRule.html&tocid=Get-WAFRRule</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>Get-WAFRRuleList</name> <description> <para>Invokes the ListRules operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRRuleList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>RuleSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRRuleList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.RuleSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RuleSummary objects. The service call response (type Amazon.WAFRegional.Model.ListRulesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRRuleList.html&tocid=Get-WAFRRuleList</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>Get-WAFRSampledRequestList</name> <description> <para>Invokes the GetSampledRequests operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRSampledRequestList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. <code>GetSampledRequests</code> returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, <code>GetSampledRequests</code> returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRSampledRequestList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeWindow_EndTime</name> <description> <para>The end of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RuleId</name> <description> <para><code>RuleId</code> is one of two values: - The <code>RuleId</code> of the <code>Rule</code> for which you want <code>GetSampledRequests</code> to return a sample of requests. - <code>Default_Action</code>, which causes <code>GetSampledRequests</code> to return a sample of the requests that didn't match any of the rules in the specified <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeWindow_StartTime</name> <description> <para>The beginning of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WebAclId</name> <description> <para>The <code>WebACLId</code> of the <code>WebACL</code> for which you want <code>GetSampledRequests</code> to return a sample of requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RuleId</name> <description> <para><code>RuleId</code> is one of two values: - The <code>RuleId</code> of the <code>Rule</code> for which you want <code>GetSampledRequests</code> to return a sample of requests. - <code>Default_Action</code>, which causes <code>GetSampledRequests</code> to return a sample of the requests that didn't match any of the rules in the specified <code>WebACL</code>. </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="False" position="Named"> <name>TimeWindow_EndTime</name> <description> <para>The end of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeWindow_StartTime</name> <description> <para>The beginning of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WebAclId</name> <description> <para>The <code>WebACLId</code> of the <code>WebACL</code> for which you want <code>GetSampledRequests</code> to return a sample of requests. </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.WAFRegional.Model.GetSampledRequestsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.GetSampledRequestsResponse 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-WAFRSampledRequestList.html&tocid=Get-WAFRSampledRequestList</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>Get-WAFRSizeConstraintSet</name> <description> <para>Invokes the GetSizeConstraintSet operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRSizeConstraintSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>SizeConstraintSet</a> specified by <code>SizeConstraintSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRSizeConstraintSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to get. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to get. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </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.WAFRegional.Model.SizeConstraintSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SizeConstraintSet object. The service call response (type Amazon.WAFRegional.Model.GetSizeConstraintSetResponse) 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-WAFRSizeConstraintSet.html&tocid=Get-WAFRSizeConstraintSet</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>Get-WAFRSizeConstraintSetList</name> <description> <para>Invokes the ListSizeConstraintSets operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRSizeConstraintSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>SizeConstraintSetSummary</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRSizeConstraintSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>SizeConstraintSet</code> objects that you want AWS WAF to return for this request. If you have more <code>SizeConstraintSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>SizeConstraintSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>SizeConstraintSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SizeConstraintSets</code>. For the second and subsequent <code>ListSizeConstraintSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SizeConstraintSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>SizeConstraintSet</code> objects that you want AWS WAF to return for this request. If you have more <code>SizeConstraintSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>SizeConstraintSet</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>SizeConstraintSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SizeConstraintSets</code>. For the second and subsequent <code>ListSizeConstraintSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SizeConstraintSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.SizeConstraintSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of SizeConstraintSetSummary objects. The service call response (type Amazon.WAFRegional.Model.ListSizeConstraintSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRSizeConstraintSetList.html&tocid=Get-WAFRSizeConstraintSetList</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>Get-WAFRSqlInjectionMatchSet</name> <description> <para>Invokes the GetSqlInjectionMatchSet operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRSqlInjectionMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>SqlInjectionMatchSet</a> that is specified by <code>SqlInjectionMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRSqlInjectionMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to get. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to get. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </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.WAFRegional.Model.SqlInjectionMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SqlInjectionMatchSet object. The service call response (type Amazon.WAFRegional.Model.GetSqlInjectionMatchSetResponse) 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-WAFRSqlInjectionMatchSet.html&tocid=Get-WAFRSqlInjectionMatchSet</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>Get-WAFRSqlInjectionMatchSetList</name> <description> <para>Invokes the ListSqlInjectionMatchSets operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRSqlInjectionMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>SqlInjectionMatchSet</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRSqlInjectionMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <a>SqlInjectionMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>SqlInjectionMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <a>SqlInjectionMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SqlInjectionMatchSets</code>. For the second and subsequent <code>ListSqlInjectionMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SqlInjectionMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <a>SqlInjectionMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>SqlInjectionMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <a>SqlInjectionMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SqlInjectionMatchSets</code>. For the second and subsequent <code>ListSqlInjectionMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SqlInjectionMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.SqlInjectionMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of SqlInjectionMatchSetSummary objects. The service call response (type Amazon.WAFRegional.Model.ListSqlInjectionMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRSqlInjectionMatchSetList.html&tocid=Get-WAFRSqlInjectionMatchSetList</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>Get-WAFRWebACL</name> <description> <para>Invokes the GetWebACL operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>WebACL</a> that is specified by <code>WebACLId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to get. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to get. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </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.WAFRegional.Model.WebACL</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a WebACL object. The service call response (type Amazon.WAFRegional.Model.GetWebACLResponse) 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-WAFRWebACL.html&tocid=Get-WAFRWebACL</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>Get-WAFRWebACLForResource</name> <description> <para>Invokes the GetWebACLForResource operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRWebACLForResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the web ACL for the specified resource. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRWebACLForResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource for which to get the web ACL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource for which to get the web ACL. </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.WAFRegional.Model.WebACLSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a WebACLSummary object. The service call response (type Amazon.WAFRegional.Model.GetWebACLForResourceResponse) 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-WAFRWebACLForResource.html&tocid=Get-WAFRWebACLForResource</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>Get-WAFRWebACLList</name> <description> <para>Invokes the ListWebACLs operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRWebACLList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>WebACLSummary</a> objects in the response.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRWebACLList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>WebACL</code> objects that you want AWS WAF to return for this request. If you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>WebACL</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>WebACL</code> objects. For the second and subsequent <code>ListWebACLs</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>WebACL</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <code>WebACL</code> objects that you want AWS WAF to return for this request. If you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>WebACL</code> objects. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>WebACL</code> objects. For the second and subsequent <code>ListWebACLs</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>WebACL</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.WebACLSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of WebACLSummary objects. The service call response (type Amazon.WAFRegional.Model.ListWebACLsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRWebACLList.html&tocid=Get-WAFRWebACLList</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>Get-WAFRXssMatchSet</name> <description> <para>Invokes the GetXssMatchSet operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRXssMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <a>XssMatchSet</a> that is specified by <code>XssMatchSetId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRXssMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to get. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to get. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </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.WAFRegional.Model.XssMatchSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a XssMatchSet object. The service call response (type Amazon.WAFRegional.Model.GetXssMatchSetResponse) 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-WAFRXssMatchSet.html&tocid=Get-WAFRXssMatchSet</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>Get-WAFRXssMatchSetList</name> <description> <para>Invokes the ListXssMatchSets operation against AWS WAF Regional.</para> </description> <verb>Get</verb> <noun>WAFRXssMatchSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <a>XssMatchSet</a> objects.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-WAFRXssMatchSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <a>XssMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>XssMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <a>XssMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>XssMatchSets</code>. For the second and subsequent <code>ListXssMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>XssMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies the number of <a>XssMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>XssMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextMarker</name> <description> <para>If you specify a value for <code>Limit</code> and you have more <a>XssMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>XssMatchSets</code>. For the second and subsequent <code>ListXssMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>XssMatchSets</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.WAFRegional.Model.XssMatchSetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of XssMatchSetSummary objects. The service call response (type Amazon.WAFRegional.Model.ListXssMatchSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-WAFRXssMatchSetList.html&tocid=Get-WAFRXssMatchSetList</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>New-WAFRByteMatchSet</name> <description> <para>Invokes the CreateByteMatchSet operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRByteMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>ByteMatchSet</code>. You then use <a>UpdateByteMatchSet</a> to identify the part of a web request that you want AWS WAF to inspect, such as the values of the <code>User-Agent</code> header or the query string. For example, you can create a <code>ByteMatchSet</code> that matches any requests with <code>User-Agent</code> headers that contain the string <code>BadBot</code>. You can then configure AWS WAF to reject those requests. To create and configure a <code>ByteMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateByteMatchSet</code> request. - Submit a <code>CreateByteMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request. - Submit an <a>UpdateByteMatchSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRByteMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>. </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.WAFRegional.Model.CreateByteMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateByteMatchSetResponse 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=New-WAFRByteMatchSet.html&tocid=New-WAFRByteMatchSet</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>New-WAFRGeoMatchSet</name> <description> <para>Invokes the CreateGeoMatchSet operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRGeoMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an <a>GeoMatchSet</a>, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an <code>GeoMatchSet</code> that contains those countries and then configure AWS WAF to block the requests. To create and configure a <code>GeoMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateGeoMatchSet</code> request. - Submit a <code>CreateGeoMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateGeoMatchSet</a> request. - Submit an <code>UpdateGeoMatchSetSet</code> request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRGeoMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>GeoMatchSet</a>. You can't change <code>Name</code> after you create the <code>GeoMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>GeoMatchSet</a>. You can't change <code>Name</code> after you create the <code>GeoMatchSet</code>. </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.WAFRegional.Model.CreateGeoMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateGeoMatchSetResponse 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=New-WAFRGeoMatchSet.html&tocid=New-WAFRGeoMatchSet</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>New-WAFRIPSet</name> <description> <para>Invokes the CreateIPSet operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRIPSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an <a>IPSet</a>, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an <code>IPSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateIPSet</code> request. - Submit a <code>CreateIPSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. - Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRIPSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>IPSet</a>. You can't change <code>Name</code> after you create the <code>IPSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>IPSet</a>. You can't change <code>Name</code> after you create the <code>IPSet</code>. </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.WAFRegional.Model.CreateIPSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateIPSetResponse 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=New-WAFRIPSet.html&tocid=New-WAFRIPSet</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>New-WAFRRateBasedRule</name> <description> <para>Invokes the CreateRateBasedRule operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRRateBasedRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <a>RateBasedRule</a>. The <code>RateBasedRule</code> contains a <code>RateLimit</code>, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The <code>RateBasedRule</code> also contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to count or block if these requests exceed the <code>RateLimit</code>. If you add more than one predicate to a <code>RateBasedRule</code>, a request not only must exceed the <code>RateLimit</code>, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a <code>RateBasedRule</code>: - An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code> - A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header Further, you specify a <code>RateLimit</code> of 15,000. You then add the <code>RateBasedRule</code> to a <code>WebACL</code> and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a <code>RateBasedRule</code>: - A <code>ByteMatchSet</code> with <code>FieldToMatch</code> of <code>URI</code> - A <code>PositionalConstraint</code> of <code>STARTS_WITH</code> - A <code>TargetString</code> of <code>login</code> Further, you specify a <code>RateLimit</code> of 15,000. By adding this <code>RateBasedRule</code> to a <code>WebACL</code>, you could limit requests to your login page without affecting the rest of your site. To create and configure a <code>RateBasedRule</code>, perform the following steps: - Create and update the predicates that you want to include in the rule. For more information, see <a>CreateByteMatchSet</a>, <a>CreateIPSet</a>, and <a>CreateSqlInjectionMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request. - Submit a <code>CreateRateBasedRule</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. - Submit an <code>UpdateRateBasedRule</code> request to specify the predicates that you want to include in the rule. - Create and update a <code>WebACL</code> that contains the <code>RateBasedRule</code>. For more information, see <a>CreateWebACL</a>. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRRateBasedRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RateBasedRule</a>. You can't change the name of a <code>RateBasedRule</code> after you create it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>RateBasedRule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>RateBasedRule</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RateKey</name> <description> <para>The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.RateKey</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RateLimit</name> <description> <para>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>. </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="False" 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="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>RateBasedRule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>RateBasedRule</code>. </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 (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RateBasedRule</a>. You can't change the name of a <code>RateBasedRule</code> after you create it. </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="False" position="Named"> <name>RateKey</name> <description> <para>The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.RateKey</parameterValue> <type> <name>Amazon.WAFRegional.RateKey</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RateLimit</name> <description> <para>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.WAFRegional.Model.CreateRateBasedRuleResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateRateBasedRuleResponse 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=New-WAFRRateBasedRule.html&tocid=New-WAFRRateBasedRule</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>New-WAFRRegexMatchSet</name> <description> <para>Invokes the CreateRegexMatchSet operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRRegexMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <a>RegexMatchSet</a>. You then use <a>UpdateRegexMatchSet</a> to identify the part of a web request that you want AWS WAF to inspect, such as the values of the <code>User-Agent</code> header or the query string. For example, you can create a <code>RegexMatchSet</code> that contains a <code>RegexMatchTuple</code> that looks for any requests with <code>User-Agent</code> headers that match a <code>RegexPatternSet</code> with pattern <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. To create and configure a <code>RegexMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRegexMatchSet</code> request. - Submit a <code>CreateRegexMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexMatchSet</code> request. - Submit an <a>UpdateRegexMatchSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a <code>RegexPatternSet</code>, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRRegexMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RegexMatchSet</a>. You can't change <code>Name</code> after you create a <code>RegexMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RegexMatchSet</a>. You can't change <code>Name</code> after you create a <code>RegexMatchSet</code>. </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.WAFRegional.Model.CreateRegexMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateRegexMatchSetResponse 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=New-WAFRRegexMatchSet.html&tocid=New-WAFRRegexMatchSet</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>New-WAFRRegexPatternSet</name> <description> <para>Invokes the CreateRegexPatternSet operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRRegexPatternSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>RegexPatternSet</code>. You then use <a>UpdateRegexPatternSet</a> to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. To create and configure a <code>RegexPatternSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRegexPatternSet</code> request. - Submit a <code>CreateRegexPatternSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexPatternSet</code> request. - Submit an <a>UpdateRegexPatternSet</a> request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRRegexPatternSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RegexPatternSet</a>. You can't change <code>Name</code> after you create a <code>RegexPatternSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>A friendly name or description of the <a>RegexPatternSet</a>. You can't change <code>Name</code> after you create a <code>RegexPatternSet</code>. </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.WAFRegional.Model.CreateRegexPatternSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateRegexPatternSetResponse 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=New-WAFRRegexPatternSet.html&tocid=New-WAFRRegexPatternSet</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>New-WAFRRule</name> <description> <para>Invokes the CreateRule operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>Rule</code>, which contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a <code>Rule</code>: - An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code> - A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to blocks requests that satisfy the <code>Rule</code>. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. To create and configure a <code>Rule</code>, perform the following steps: - Create and update the predicates that you want to include in the <code>Rule</code>. For more information, see <a>CreateByteMatchSet</a>, <a>CreateIPSet</a>, and <a>CreateSqlInjectionMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request. - Submit a <code>CreateRule</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. - Submit an <code>UpdateRule</code> request to specify the predicates that you want to include in the <code>Rule</code>. - Create and update a <code>WebACL</code> that contains the <code>Rule</code>. For more information, see <a>CreateWebACL</a>. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>Rule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>Rule</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>Rule</a>. You can't change the name of a <code>Rule</code> after you create it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>Rule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>Rule</code>. </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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>Rule</a>. You can't change the name of a <code>Rule</code> after you create it. </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.WAFRegional.Model.CreateRuleResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateRuleResponse 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=New-WAFRRule.html&tocid=New-WAFRRule</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>New-WAFRSizeConstraintSet</name> <description> <para>Invokes the CreateSizeConstraintSet operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRSizeConstraintSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>SizeConstraintSet</code>. You then use <a>UpdateSizeConstraintSet</a> to identify the part of a web request that you want AWS WAF to check for length, such as the length of the <code>User-Agent</code> header or the length of the query string. For example, you can create a <code>SizeConstraintSet</code> that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a <code>SizeConstraintSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSizeConstraintSet</code> request. - Submit a <code>CreateSizeConstraintSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateSizeConstraintSet</code> request. - Submit an <a>UpdateSizeConstraintSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRSizeConstraintSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>SizeConstraintSet</a>. You can't change <code>Name</code> after you create a <code>SizeConstraintSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>SizeConstraintSet</a>. You can't change <code>Name</code> after you create a <code>SizeConstraintSet</code>. </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.WAFRegional.Model.CreateSizeConstraintSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateSizeConstraintSetResponse 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=New-WAFRSizeConstraintSet.html&tocid=New-WAFRSizeConstraintSet</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>New-WAFRSqlInjectionMatchSet</name> <description> <para>Invokes the CreateSqlInjectionMatchSet operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRSqlInjectionMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <a>SqlInjectionMatchSet</a>, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSqlInjectionMatchSet</code> request. - Submit a <code>CreateSqlInjectionMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateSqlInjectionMatchSet</a> request. - Submit an <a>UpdateSqlInjectionMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRSqlInjectionMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description for the <a>SqlInjectionMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>SqlInjectionMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description for the <a>SqlInjectionMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>SqlInjectionMatchSet</code>. </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.WAFRegional.Model.CreateSqlInjectionMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateSqlInjectionMatchSetResponse 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=New-WAFRSqlInjectionMatchSet.html&tocid=New-WAFRSqlInjectionMatchSet</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>New-WAFRWebACL</name> <description> <para>Invokes the CreateWebACL operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>WebACL</code>, which contains the <code>Rules</code> that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates <code>Rules</code> in order based on the value of <code>Priority</code> for each <code>Rule</code>. You also specify a default action, either <code>ALLOW</code> or <code>BLOCK</code>. If a web request doesn't match any of the <code>Rules</code> in a <code>WebACL</code>, AWS WAF responds to the request with the default action. To create and configure a <code>WebACL</code>, perform the following steps: - Create and update the <code>ByteMatchSet</code> objects and other predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>. - Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateWebACL</code> request. - Submit a <code>CreateWebACL</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request. - Submit an <a>UpdateWebACL</a> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution. For more information about how to use the AWS WAF API, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>WebACL</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change <code>MetricName</code> after you create the <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>WebACL</a>. You can't change <code>Name</code> after you create the <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultAction_Type</name> <description> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following: - <code>ALLOW</code>: AWS WAF allows requests - <code>BLOCK</code>: AWS WAF blocks requests - <code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.WafActionType</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" position="Named"> <name>DefaultAction_Type</name> <description> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following: - <code>ALLOW</code>: AWS WAF allows requests - <code>BLOCK</code>: AWS WAF blocks requests - <code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.WafActionType</parameterValue> <type> <name>Amazon.WAFRegional.WafActionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricName</name> <description> <para>A friendly name or description for the metrics for this <code>WebACL</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change <code>MetricName</code> after you create the <code>WebACL</code>. </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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description of the <a>WebACL</a>. You can't change <code>Name</code> after you create the <code>WebACL</code>. </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.WAFRegional.Model.CreateWebACLResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateWebACLResponse 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=New-WAFRWebACL.html&tocid=New-WAFRWebACL</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>New-WAFRXssMatchSet</name> <description> <para>Invokes the CreateXssMatchSet operation against AWS WAF Regional.</para> </description> <verb>New</verb> <noun>WAFRXssMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an <a>XssMatchSet</a>, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an <code>XssMatchSet</code>, perform the following steps: - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateXssMatchSet</code> request. - Submit a <code>CreateXssMatchSet</code> request. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateXssMatchSet</a> request. - Submit an <a>UpdateXssMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-WAFRXssMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description for the <a>XssMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>XssMatchSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>A friendly name or description for the <a>XssMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>XssMatchSet</code>. </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.WAFRegional.Model.CreateXssMatchSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.WAFRegional.Model.CreateXssMatchSetResponse 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=New-WAFRXssMatchSet.html&tocid=New-WAFRXssMatchSet</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>Register-WAFRWebACL</name> <description> <para>Invokes the AssociateWebACL operation against AWS WAF Regional.</para> </description> <verb>Register</verb> <noun>WAFRWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates a web ACL with a resource. </para> </description> <syntax> <syntaxItem> <name>Register-WAFRWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>A unique identifier (ID) for the web ACL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource to be protected. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WebACLId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WebACLId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource to be protected. </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 (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>A unique identifier (ID) for the web ACL. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the WebACLId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WAFRegional.Model.AssociateWebACLResponse) 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=Register-WAFRWebACL.html&tocid=Register-WAFRWebACL</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-WAFRByteMatchSet</name> <description> <para>Invokes the DeleteByteMatchSet operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRByteMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>ByteMatchSet</a>. You can't delete a <code>ByteMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>ByteMatchTuple</a> objects (any filters). If you just want to remove a <code>ByteMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>ByteMatchSet</code>, perform the following steps: - Update the <code>ByteMatchSet</code> to remove filters, if any. For more information, see <a>UpdateByteMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteByteMatchSet</code> request. - Submit a <code>DeleteByteMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRByteMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to delete. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to delete. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </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="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteByteMatchSetResponse) 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=Remove-WAFRByteMatchSet.html&tocid=Remove-WAFRByteMatchSet</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-WAFRGeoMatchSet</name> <description> <para>Invokes the DeleteGeoMatchSet operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRGeoMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>GeoMatchSet</a>. You can't delete a <code>GeoMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any countries. If you just want to remove a <code>GeoMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>GeoMatchSet</code> from AWS WAF, perform the following steps: - Update the <code>GeoMatchSet</code> to remove any countries. For more information, see <a>UpdateGeoMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteGeoMatchSet</code> request. - Submit a <code>DeleteGeoMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRGeoMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetID</code> of the <a>GeoMatchSet</a> that you want to delete. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetID</code> of the <a>GeoMatchSet</a> that you want to delete. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteGeoMatchSetResponse) 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=Remove-WAFRGeoMatchSet.html&tocid=Remove-WAFRGeoMatchSet</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-WAFRIPSet</name> <description> <para>Invokes the DeleteIPSet operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRIPSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes an <a>IPSet</a>. You can't delete an <code>IPSet</code> if it's still used in any <code>Rules</code> or if it still includes any IP addresses. If you just want to remove an <code>IPSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete an <code>IPSet</code> from AWS WAF, perform the following steps: - Update the <code>IPSet</code> to remove IP address ranges, if any. For more information, see <a>UpdateIPSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteIPSet</code> request. - Submit a <code>DeleteIPSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRIPSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to delete. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to delete. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteIPSetResponse) 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=Remove-WAFRIPSet.html&tocid=Remove-WAFRIPSet</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-WAFRRateBasedRule</name> <description> <para>Invokes the DeleteRateBasedRule operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRRateBasedRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>RateBasedRule</a>. You can't delete a rule if it's still used in any <code>WebACL</code> objects or if it still includes any predicates, such as <code>ByteMatchSet</code> objects. If you just want to remove a rule from a <code>WebACL</code>, use <a>UpdateWebACL</a>. To permanently delete a <code>RateBasedRule</code> from AWS WAF, perform the following steps: - Update the <code>RateBasedRule</code> to remove predicates, if any. For more information, see <a>UpdateRateBasedRule</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRateBasedRule</code> request. - Submit a <code>DeleteRateBasedRule</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRRateBasedRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteRateBasedRuleResponse) 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=Remove-WAFRRateBasedRule.html&tocid=Remove-WAFRRateBasedRule</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-WAFRRegexMatchSet</name> <description> <para>Invokes the DeleteRegexMatchSet operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRRegexMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>RegexMatchSet</a>. You can't delete a <code>RegexMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any <code>RegexMatchTuples</code> objects (any filters). If you just want to remove a <code>RegexMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>RegexMatchSet</code>, perform the following steps: - Update the <code>RegexMatchSet</code> to remove filters, if any. For more information, see <a>UpdateRegexMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRegexMatchSet</code> request. - Submit a <code>DeleteRegexMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRRegexMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to delete. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to delete. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteRegexMatchSetResponse) 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=Remove-WAFRRegexMatchSet.html&tocid=Remove-WAFRRegexMatchSet</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-WAFRRegexPatternSet</name> <description> <para>Invokes the DeleteRegexPatternSet operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRRegexPatternSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>RegexPatternSet</a>. You can't delete a <code>RegexPatternSet</code> if it's still used in any <code>RegexMatchSet</code> or if the <code>RegexPatternSet</code> is not empty. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRRegexPatternSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to delete. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to delete. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteRegexPatternSetResponse) 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=Remove-WAFRRegexPatternSet.html&tocid=Remove-WAFRRegexPatternSet</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-WAFRRule</name> <description> <para>Invokes the DeleteRule operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>Rule</a>. You can't delete a <code>Rule</code> if it's still used in any <code>WebACL</code> objects or if it still includes any predicates, such as <code>ByteMatchSet</code> objects. If you just want to remove a <code>Rule</code> from a <code>WebACL</code>, use <a>UpdateWebACL</a>. To permanently delete a <code>Rule</code> from AWS WAF, perform the following steps: - Update the <code>Rule</code> to remove predicates, if any. For more information, see <a>UpdateRule</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRule</code> request. - Submit a <code>DeleteRule</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteRuleResponse) 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=Remove-WAFRRule.html&tocid=Remove-WAFRRule</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-WAFRSizeConstraintSet</name> <description> <para>Invokes the DeleteSizeConstraintSet operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRSizeConstraintSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>SizeConstraintSet</a>. You can't delete a <code>SizeConstraintSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>SizeConstraint</a> objects (any filters). If you just want to remove a <code>SizeConstraintSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>SizeConstraintSet</code>, perform the following steps: - Update the <code>SizeConstraintSet</code> to remove filters, if any. For more information, see <a>UpdateSizeConstraintSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSizeConstraintSet</code> request. - Submit a <code>DeleteSizeConstraintSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRSizeConstraintSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to delete. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to delete. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteSizeConstraintSetResponse) 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=Remove-WAFRSizeConstraintSet.html&tocid=Remove-WAFRSizeConstraintSet</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-WAFRSqlInjectionMatchSet</name> <description> <para>Invokes the DeleteSqlInjectionMatchSet operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRSqlInjectionMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>SqlInjectionMatchSet</a>. You can't delete a <code>SqlInjectionMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>SqlInjectionMatchTuple</a> objects. If you just want to remove a <code>SqlInjectionMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete a <code>SqlInjectionMatchSet</code> from AWS WAF, perform the following steps: - Update the <code>SqlInjectionMatchSet</code> to remove filters, if any. For more information, see <a>UpdateSqlInjectionMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSqlInjectionMatchSet</code> request. - Submit a <code>DeleteSqlInjectionMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRSqlInjectionMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to delete. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to delete. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteSqlInjectionMatchSetResponse) 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=Remove-WAFRSqlInjectionMatchSet.html&tocid=Remove-WAFRSqlInjectionMatchSet</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-WAFRWebACL</name> <description> <para>Invokes the DeleteWebACL operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes a <a>WebACL</a>. You can't delete a <code>WebACL</code> if it still contains any <code>Rules</code>. To delete a <code>WebACL</code>, perform the following steps: - Update the <code>WebACL</code> to remove <code>Rules</code>, if any. For more information, see <a>UpdateWebACL</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteWebACL</code> request. - Submit a <code>DeleteWebACL</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to delete. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to delete. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteWebACLResponse) 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=Remove-WAFRWebACL.html&tocid=Remove-WAFRWebACL</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-WAFRXssMatchSet</name> <description> <para>Invokes the DeleteXssMatchSet operation against AWS WAF Regional.</para> </description> <verb>Remove</verb> <noun>WAFRXssMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes an <a>XssMatchSet</a>. You can't delete an <code>XssMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>XssMatchTuple</a> objects. If you just want to remove an <code>XssMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. To permanently delete an <code>XssMatchSet</code> from AWS WAF, perform the following steps: - Update the <code>XssMatchSet</code> to remove filters, if any. For more information, see <a>UpdateXssMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteXssMatchSet</code> request. - Submit a <code>DeleteXssMatchSet</code> request. </para> </description> <syntax> <syntaxItem> <name>Remove-WAFRXssMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to delete. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to delete. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.DeleteXssMatchSetResponse) 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=Remove-WAFRXssMatchSet.html&tocid=Remove-WAFRXssMatchSet</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>Unregister-WAFRWebACL</name> <description> <para>Invokes the DisassociateWebACL operation against AWS WAF Regional.</para> </description> <verb>Unregister</verb> <noun>WAFRWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes a web ACL from the specified resource. </para> </description> <syntax> <syntaxItem> <name>Unregister-WAFRWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.WAFRegional.Model.DisassociateWebACLResponse) 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=Unregister-WAFRWebACL.html&tocid=Unregister-WAFRWebACL</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>Update-WAFRByteMatchSet</name> <description> <para>Invokes the UpdateByteMatchSet operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRByteMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>ByteMatchTuple</a> objects (filters) in a <a>ByteMatchSet</a>. For each <code>ByteMatchTuple</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change a <code>ByteMatchSetUpdate</code> object, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the <code>User-Agent</code> header. - The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see <code>TargetString</code> in the <a>ByteMatchTuple</a> data type. - Where to look, such as at the beginning or the end of a query string. - Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a <code>ByteMatchSetUpdate</code> object that matches web requests in which <code>User-Agent</code> headers contain the string <code>BadBot</code>. You can then configure AWS WAF to block those requests. To create and configure a <code>ByteMatchSet</code>, perform the following steps: - Create a <code>ByteMatchSet.</code> For more information, see <a>CreateByteMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request. - Submit an <code>UpdateByteMatchSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRByteMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to update. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>ByteMatchSetUpdate</code> objects that you want to insert into or delete from a <a>ByteMatchSet</a>. For more information, see the applicable data types: - <a>ByteMatchSetUpdate</a>: Contains <code>Action</code> and <code>ByteMatchTuple</code> - <a>ByteMatchTuple</a>: Contains <code>FieldToMatch</code>, <code>PositionalConstraint</code>, <code>TargetString</code>, and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.ByteMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ByteMatchSetId</name> <description> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to update. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>. </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="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>ByteMatchSetUpdate</code> objects that you want to insert into or delete from a <a>ByteMatchSet</a>. For more information, see the applicable data types: - <a>ByteMatchSetUpdate</a>: Contains <code>Action</code> and <code>ByteMatchTuple</code> - <a>ByteMatchTuple</a>: Contains <code>FieldToMatch</code>, <code>PositionalConstraint</code>, <code>TargetString</code>, and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.ByteMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.ByteMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateByteMatchSetResponse) 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=Update-WAFRByteMatchSet.html&tocid=Update-WAFRByteMatchSet</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>Update-WAFRGeoMatchSet</name> <description> <para>Invokes the UpdateGeoMatchSet operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRGeoMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>GeoMatchConstraint</a> objects in an <code>GeoMatchSet</code>. For each <code>GeoMatchConstraint</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change an <code>GeoMatchConstraint</code> object, you delete the existing object and add a new one. - The <code>Type</code>. The only valid value for <code>Type</code> is <code>Country</code>. - The <code>Value</code>, which is a two character code for the country to add to the <code>GeoMatchConstraint</code> object. Valid codes are listed in <a>GeoMatchConstraint$Value</a>. To create and configure an <code>GeoMatchSet</code>, perform the following steps: - Submit a <a>CreateGeoMatchSet</a> request. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateGeoMatchSet</a> request. - Submit an <code>UpdateGeoMatchSet</code> request to specify the country that you want AWS WAF to watch for. When you update an <code>GeoMatchSet</code>, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRGeoMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to update. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>GeoMatchSetUpdate</code> objects that you want to insert into or delete from an <a>GeoMatchSet</a>. For more information, see the applicable data types: - <a>GeoMatchSetUpdate</a>: Contains <code>Action</code> and <code>GeoMatchConstraint</code> - <a>GeoMatchConstraint</a>: Contains <code>Type</code> and <code>Value</code> You can have only one <code>Type</code> and <code>Value</code> per <code>GeoMatchConstraint</code>. To add multiple countries, include multiple <code>GeoMatchSetUpdate</code> objects in your request. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.GeoMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>GeoMatchSetId</name> <description> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to update. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>GeoMatchSetUpdate</code> objects that you want to insert into or delete from an <a>GeoMatchSet</a>. For more information, see the applicable data types: - <a>GeoMatchSetUpdate</a>: Contains <code>Action</code> and <code>GeoMatchConstraint</code> - <a>GeoMatchConstraint</a>: Contains <code>Type</code> and <code>Value</code> You can have only one <code>Type</code> and <code>Value</code> per <code>GeoMatchConstraint</code>. To add multiple countries, include multiple <code>GeoMatchSetUpdate</code> objects in your request. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.GeoMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.GeoMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateGeoMatchSetResponse) 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=Update-WAFRGeoMatchSet.html&tocid=Update-WAFRGeoMatchSet</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>Update-WAFRIPSet</name> <description> <para>Invokes the UpdateIPSet operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRIPSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>IPSetDescriptor</a> objects in an <code>IPSet</code>. For each <code>IPSetDescriptor</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code> object, you delete the existing object and add a new one. - The IP address version, <code>IPv4</code> or <code>IPv6</code>. - The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code> (for the individual IP address <code>192.0.2.44</code>). AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. IPv6 addresses can be represented using any of the following formats: - 1111:0000:0000:0000:0000:0000:0000:0111/128 - 1111:0:0:0:0:0:0:0111/128 - 1111::0111/128 - 1111::111/128 You use an <code>IPSet</code> to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an <code>IPSet</code>, perform the following steps: - Submit a <a>CreateIPSet</a> request. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. - Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for. When you update an <code>IPSet</code>, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRIPSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to update. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>IPSetUpdate</code> objects that you want to insert into or delete from an <a>IPSet</a>. For more information, see the applicable data types: - <a>IPSetUpdate</a>: Contains <code>Action</code> and <code>IPSetDescriptor</code> - <a>IPSetDescriptor</a>: Contains <code>Type</code> and <code>Value</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.IPSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>IPSetId</name> <description> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to update. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>IPSetUpdate</code> objects that you want to insert into or delete from an <a>IPSet</a>. For more information, see the applicable data types: - <a>IPSetUpdate</a>: Contains <code>Action</code> and <code>IPSetDescriptor</code> - <a>IPSetDescriptor</a>: Contains <code>Type</code> and <code>Value</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.IPSetUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.IPSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateIPSetResponse) 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=Update-WAFRIPSet.html&tocid=Update-WAFRIPSet</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>Update-WAFRRateBasedRule</name> <description> <para>Invokes the UpdateRateBasedRule operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRRateBasedRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>Predicate</a> objects in a rule and updates the <code>RateLimit</code> in the rule. Each <code>Predicate</code> object identifies a predicate, such as a <a>ByteMatchSet</a> or an <a>IPSet</a>, that specifies the web requests that you want to block or count. The <code>RateLimit</code> specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a <code>RateBasedRule</code>, a request must match all the predicates and exceed the <code>RateLimit</code> to be counted or blocked. For example, suppose you add the following to a <code>RateBasedRule</code>: - An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code> - A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header Further, you specify a <code>RateLimit</code> of 15,000. You then add the <code>RateBasedRule</code> to a <code>WebACL</code> and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a <code>RateBasedRule</code>: - A <code>ByteMatchSet</code> with <code>FieldToMatch</code> of <code>URI</code> - A <code>PositionalConstraint</code> of <code>STARTS_WITH</code> - A <code>TargetString</code> of <code>login</code> Further, you specify a <code>RateLimit</code> of 15,000. By adding this <code>RateBasedRule</code> to a <code>WebACL</code>, you could limit requests to your login page without affecting the rest of your site. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRRateBasedRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <code>RateBasedRule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRateBasedRule</code> and by <a>ListRateBasedRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RateLimit</name> <description> <para>The maximum number of requests, which have an identical value in the field specified by the <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>RateBasedRule</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.RuleUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>RateLimit</name> <description> <para>The maximum number of requests, which have an identical value in the field specified by the <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <code>RateBasedRule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRateBasedRule</code> and by <a>ListRateBasedRules</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>RateBasedRule</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.RuleUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.RuleUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateRateBasedRuleResponse) 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=Update-WAFRRateBasedRule.html&tocid=Update-WAFRRateBasedRule</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>Update-WAFRRegexMatchSet</name> <description> <para>Invokes the UpdateRegexMatchSet operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRRegexMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>RegexMatchSetUpdate</a> objects (filters) in a <a>RegexMatchSet</a>. For each <code>RegexMatchSetUpdate</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change a <code>RegexMatchSetUpdate</code> object, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the <code>User-Agent</code> header. - The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see <a>RegexPatternSet</a>. - Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a <code>RegexPatternSet</code> that matches any requests with <code>User-Agent</code> headers that contain the string <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. To create and configure a <code>RegexMatchSet</code>, perform the following steps: - Create a <code>RegexMatchSet.</code> For more information, see <a>CreateRegexMatchSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexMatchSet</code> request. - Submit an <code>UpdateRegexMatchSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the <code>RegexPatternSet</code> that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRRegexMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to update. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RegexMatchSetUpdate</code> objects that you want to insert into or delete from a <a>RegexMatchSet</a>. For more information, see <a>RegexMatchTuple</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.RegexMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RegexMatchSetId</name> <description> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to update. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RegexMatchSetUpdate</code> objects that you want to insert into or delete from a <a>RegexMatchSet</a>. For more information, see <a>RegexMatchTuple</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.RegexMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.RegexMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateRegexMatchSetResponse) 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=Update-WAFRRegexMatchSet.html&tocid=Update-WAFRRegexMatchSet</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>Update-WAFRRegexPatternSet</name> <description> <para>Invokes the UpdateRegexPatternSet operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRRegexPatternSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>RegexMatchSetUpdate</a> objects (filters) in a <a>RegexPatternSet</a>. For each <code>RegexPatternSet</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change a <code>RegexPatternSet</code> object, you delete the existing object and add a new one. - The regular expression pattern that you want AWS WAF to look for. For more information, see <a>RegexPatternSet</a>. For example, you can create a <code>RegexPatternString</code> such as <code>B[a@]dB[o0]t</code>. AWS WAF will match this <code>RegexPatternString</code> to: - BadBot - BadB0t - B@dBot - B@dB0t To create and configure a <code>RegexPatternSet</code>, perform the following steps: - Create a <code>RegexPatternSet.</code> For more information, see <a>CreateRegexPatternSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexPatternSet</code> request. - Submit an <code>UpdateRegexPatternSet</code> request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRRegexPatternSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to update. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RegexPatternSetUpdate</code> objects that you want to insert into or delete from a <a>RegexPatternSet</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.RegexPatternSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RegexPatternSetId</name> <description> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to update. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RegexPatternSetUpdate</code> objects that you want to insert into or delete from a <a>RegexPatternSet</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.RegexPatternSetUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.RegexPatternSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateRegexPatternSetResponse) 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=Update-WAFRRegexPatternSet.html&tocid=Update-WAFRRegexPatternSet</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>Update-WAFRRule</name> <description> <para>Invokes the UpdateRule operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>Predicate</a> objects in a <code>Rule</code>. Each <code>Predicate</code> object identifies a predicate, such as a <a>ByteMatchSet</a> or an <a>IPSet</a>, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a <code>Rule</code>: - A <code>ByteMatchSet</code> that matches the value <code>BadBot</code> in the <code>User-Agent</code> header - An <code>IPSet</code> that matches the IP address <code>192.0.2.44</code> You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to block requests that satisfy the <code>Rule</code>. For a request to be blocked, the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code><i>and</i> the request must originate from the IP address 192.0.2.44. To create and configure a <code>Rule</code>, perform the following steps: - Create and update the predicates that you want to include in the <code>Rule</code>. - Create the <code>Rule</code>. See <a>CreateRule</a>. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. - Submit an <code>UpdateRule</code> request to add predicates to the <code>Rule</code>. - Create and update a <code>WebACL</code> that contains the <code>Rule</code>. See <a>CreateWebACL</a>. If you want to replace one <code>ByteMatchSet</code> or <code>IPSet</code> with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <code>Rule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRule</code> and by <a>ListRules</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>Rule</a>. For more information, see the applicable data types: - <a>RuleUpdate</a>: Contains <code>Action</code> and <code>Predicate</code> - <a>Predicate</a>: Contains <code>DataId</code>, <code>Negated</code>, and <code>Type</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.RuleUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>RuleId</name> <description> <para>The <code>RuleId</code> of the <code>Rule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRule</code> and by <a>ListRules</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>Rule</a>. For more information, see the applicable data types: - <a>RuleUpdate</a>: Contains <code>Action</code> and <code>Predicate</code> - <a>Predicate</a>: Contains <code>DataId</code>, <code>Negated</code>, and <code>Type</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.RuleUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.RuleUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateRuleResponse) 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=Update-WAFRRule.html&tocid=Update-WAFRRule</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>Update-WAFRSizeConstraintSet</name> <description> <para>Invokes the UpdateSizeConstraintSet operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRSizeConstraintSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>SizeConstraint</a> objects (filters) in a <a>SizeConstraintSet</a>. For each <code>SizeConstraint</code> object, you specify the following values: - Whether to insert or delete the object from the array. If you want to change a <code>SizeConstraintSetUpdate</code> object, you delete the existing object and add a new one. - The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the <code>User-Agent</code> header. - Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first <code>8192</code> bytes of your request to AWS WAF. - A <code>ComparisonOperator</code> used for evaluating the selected part of the request against the specified <code>Size</code>, such as equals, greater than, less than, and so on. - The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a <code>SizeConstraintSetUpdate</code> object that matches web requests in which the length of the <code>User-Agent</code> header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a <code>SizeConstraintSet</code>, perform the following steps: - Create a <code>SizeConstraintSet.</code> For more information, see <a>CreateSizeConstraintSet</a>. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateSizeConstraintSet</code> request. - Submit an <code>UpdateSizeConstraintSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRSizeConstraintSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to update. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>SizeConstraintSetUpdate</code> objects that you want to insert into or delete from a <a>SizeConstraintSet</a>. For more information, see the applicable data types: - <a>SizeConstraintSetUpdate</a>: Contains <code>Action</code> and <code>SizeConstraint</code> - <a>SizeConstraint</a>: Contains <code>FieldToMatch</code>, <code>TextTransformation</code>, <code>ComparisonOperator</code>, and <code>Size</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.SizeConstraintSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>SizeConstraintSetId</name> <description> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to update. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>SizeConstraintSetUpdate</code> objects that you want to insert into or delete from a <a>SizeConstraintSet</a>. For more information, see the applicable data types: - <a>SizeConstraintSetUpdate</a>: Contains <code>Action</code> and <code>SizeConstraint</code> - <a>SizeConstraint</a>: Contains <code>FieldToMatch</code>, <code>TextTransformation</code>, <code>ComparisonOperator</code>, and <code>Size</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.SizeConstraintSetUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.SizeConstraintSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateSizeConstraintSetResponse) 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=Update-WAFRSizeConstraintSet.html&tocid=Update-WAFRSizeConstraintSet</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>Update-WAFRSqlInjectionMatchSet</name> <description> <para>Invokes the UpdateSqlInjectionMatchSet operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRSqlInjectionMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>SqlInjectionMatchTuple</a> objects (filters) in a <a>SqlInjectionMatchSet</a>. For each <code>SqlInjectionMatchTuple</code> object, you specify the following values: - <code>Action</code>: Whether to insert the object into or delete the object from the array. To change a <code>SqlInjectionMatchTuple</code>, you delete the existing object and add a new one. - <code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header. - <code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You use <code>SqlInjectionMatchSet</code> objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a <code>SqlInjectionMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps: - Submit a <a>CreateSqlInjectionMatchSet</a> request. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. - Submit an <code>UpdateSqlInjectionMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRSqlInjectionMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <code>SqlInjectionMatchSet</code> that you want to update. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>SqlInjectionMatchSetUpdate</code> objects that you want to insert into or delete from a <a>SqlInjectionMatchSet</a>. For more information, see the applicable data types: - <a>SqlInjectionMatchSetUpdate</a>: Contains <code>Action</code> and <code>SqlInjectionMatchTuple</code> - <a>SqlInjectionMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.SqlInjectionMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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 (ByValue, )" position="1"> <name>SqlInjectionMatchSetId</name> <description> <para>The <code>SqlInjectionMatchSetId</code> of the <code>SqlInjectionMatchSet</code> that you want to update. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>. </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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>SqlInjectionMatchSetUpdate</code> objects that you want to insert into or delete from a <a>SqlInjectionMatchSet</a>. For more information, see the applicable data types: - <a>SqlInjectionMatchSetUpdate</a>: Contains <code>Action</code> and <code>SqlInjectionMatchTuple</code> - <a>SqlInjectionMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.SqlInjectionMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.SqlInjectionMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateSqlInjectionMatchSetResponse) 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=Update-WAFRSqlInjectionMatchSet.html&tocid=Update-WAFRSqlInjectionMatchSet</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>Update-WAFRWebACL</name> <description> <para>Invokes the UpdateWebACL operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRWebACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>ActivatedRule</a> objects in a <code>WebACL</code>. Each <code>Rule</code> identifies web requests that you want to allow, block, or count. When you update a <code>WebACL</code>, you specify the following values: - A default action for the <code>WebACL</code>, either <code>ALLOW</code> or <code>BLOCK</code>. AWS WAF performs the default action if a request doesn't match the criteria in any of the <code>Rules</code> in a <code>WebACL</code>. - The <code>Rules</code> that you want to add and/or delete. If you want to replace one <code>Rule</code> with another, you delete the existing <code>Rule</code> and add the new one. - For each <code>Rule</code>, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the <code>Rule</code>. - The order in which you want AWS WAF to evaluate the <code>Rules</code> in a <code>WebACL</code>. If you add more than one <code>Rule</code> to a <code>WebACL</code>, AWS WAF evaluates each request against the <code>Rules</code> in order based on the value of <code>Priority</code>. (The <code>Rule</code> that has the lowest value for <code>Priority</code> is evaluated first.) When a web request matches all of the predicates (such as <code>ByteMatchSets</code> and <code>IPSets</code>) in a <code>Rule</code>, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining <code>Rules</code> in the <code>WebACL</code>, if any. To create and configure a <code>WebACL</code>, perform the following steps: - Create and update the predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>. - Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>. - Create a <code>WebACL</code>. See <a>CreateWebACL</a>. - Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request. - Submit an <code>UpdateWebACL</code> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the <a>UpdateWebACL</a> request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRWebACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to update. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultAction_Type</name> <description> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following: - <code>ALLOW</code>: AWS WAF allows requests - <code>BLOCK</code>: AWS WAF blocks requests - <code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.WafActionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of updates to make to the <a>WebACL</a>. An array of <code>WebACLUpdate</code> objects that you want to insert into or delete from a <a>WebACL</a>. For more information, see the applicable data types: - <a>WebACLUpdate</a>: Contains <code>Action</code> and <code>ActivatedRule</code> - <a>ActivatedRule</a>: Contains <code>Action</code>, <code>Priority</code>, <code>RuleId</code>, and <code>Type</code> - <a>WafAction</a>: Contains <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.WebACLUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" position="Named"> <name>DefaultAction_Type</name> <description> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following: - <code>ALLOW</code>: AWS WAF allows requests - <code>BLOCK</code>: AWS WAF blocks requests - <code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.WafActionType</parameterValue> <type> <name>Amazon.WAFRegional.WafActionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Update</name> <description> <para>An array of updates to make to the <a>WebACL</a>. An array of <code>WebACLUpdate</code> objects that you want to insert into or delete from a <a>WebACL</a>. For more information, see the applicable data types: - <a>WebACLUpdate</a>: Contains <code>Action</code> and <code>ActivatedRule</code> - <a>ActivatedRule</a>: Contains <code>Action</code>, <code>Priority</code>, <code>RuleId</code>, and <code>Type</code> - <a>WafAction</a>: Contains <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.WebACLUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.WebACLUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WebACLId</name> <description> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to update. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateWebACLResponse) 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=Update-WAFRWebACL.html&tocid=Update-WAFRWebACL</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>Update-WAFRXssMatchSet</name> <description> <para>Invokes the UpdateXssMatchSet operation against AWS WAF Regional.</para> </description> <verb>Update</verb> <noun>WAFRXssMatchSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Inserts or deletes <a>XssMatchTuple</a> objects (filters) in an <a>XssMatchSet</a>. For each <code>XssMatchTuple</code> object, you specify the following values: - <code>Action</code>: Whether to insert the object into or delete the object from the array. To change a <code>XssMatchTuple</code>, you delete the existing object and add a new one. - <code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header. - <code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You use <code>XssMatchSet</code> objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an <code>XssMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an <code>XssMatchSet</code>, perform the following steps: - Submit a <a>CreateXssMatchSet</a> request. - Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. - Submit an <code>UpdateXssMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-WAFRXssMatchSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Update</name> <description> <para>An array of <code>XssMatchSetUpdate</code> objects that you want to insert into or delete from a <a>XssMatchSet</a>. For more information, see the applicable data types: - <a>XssMatchSetUpdate</a>: Contains <code>Action</code> and <code>XssMatchTuple</code> - <a>XssMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.XssMatchSetUpdate[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <code>XssMatchSet</code> that you want to update. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChangeToken</name> <description> <para>The value returned by the most recent call to <a>GetChangeToken</a>. </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="False" 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="False" position="Named"> <name>Update</name> <description> <para>An array of <code>XssMatchSetUpdate</code> objects that you want to insert into or delete from a <a>XssMatchSet</a>. For more information, see the applicable data types: - <a>XssMatchSetUpdate</a>: Contains <code>Action</code> and <code>XssMatchTuple</code> - <a>XssMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code> - <a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.WAFRegional.Model.XssMatchSetUpdate[]</parameterValue> <type> <name>Amazon.WAFRegional.Model.XssMatchSetUpdate[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>XssMatchSetId</name> <description> <para>The <code>XssMatchSetId</code> of the <code>XssMatchSet</code> that you want to update. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.WAFRegional.Model.UpdateXssMatchSetResponse) 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=Update-WAFRXssMatchSet.html&tocid=Update-WAFRXssMatchSet</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>Add-SGCache</name> <description> <para>Invokes the AddCache operation against AWS Storage Gateway.</para> </description> <verb>Add</verb> <noun>SGCache</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway architectures (see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html">Storage Gateway Concepts</a>). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache. </para> </description> <syntax> <syntaxItem> <name>Add-SGCache</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DiskId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DiskId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.AddCacheResponse) 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=Add-SGCache.html&tocid=Add-SGCache</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Add-SGResourceTag</name> <description> <para>Invokes the AddTagsToResource operation against AWS Storage Gateway.</para> </description> <verb>Add</verb> <noun>SGResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: - Storage gateways of all types - Storage Volumes - Virtual Tapes You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. </para> </description> <syntax> <syntaxItem> <name>Add-SGResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceARN</name> <description> <para>The Amazon Resource Name (ARN) of the resource you want to add tags to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>The key-value pair that represents the tag you want to add to the resource. The value can be an empty string. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. </para> </description> <parameterValue required="true" variableLength="false">Amazon.StorageGateway.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>ResourceARN</name> <description> <para>The Amazon Resource Name (ARN) of the resource you want to add tags to. </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="False" position="Named"> <name>Tag</name> <description> <para>The key-value pair that represents the tag you want to add to the resource. The value can be an empty string. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. </para> </description> <parameterValue required="true" variableLength="false">Amazon.StorageGateway.Model.Tag[]</parameterValue> <type> <name>Amazon.StorageGateway.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.AddTagsToResourceResponse) 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=Add-SGResourceTag.html&tocid=Add-SGResourceTag</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Add-SGUploadBuffer</name> <description> <para>Invokes the AddUploadBuffer operation against AWS Storage Gateway.</para> </description> <verb>Add</verb> <noun>SGUploadBuffer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway architectures. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. </para> </description> <syntax> <syntaxItem> <name>Add-SGUploadBuffer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DiskId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DiskId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.AddUploadBufferResponse) 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=Add-SGUploadBuffer.html&tocid=Add-SGUploadBuffer</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Add-SGWorkingStorage</name> <description> <para>Invokes the AddWorkingStorage operation against AWS Storage Gateway.</para> </description> <verb>Add</verb> <noun>SGWorkingStorage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway architecture. This operation is deprecated in cached volume API version 20120630. Use <a>AddUploadBuffer</a> instead. Working storage is also referred to as upload buffer. You can also use the <a>AddUploadBuffer</a> operation to add upload buffer to a stored volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. </para> </description> <syntax> <syntaxItem> <name>Add-SGWorkingStorage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DiskId</name> <description> <para>An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the <a>ListLocalDisks</a> API. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DiskId</name> <description> <para>An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the <a>ListLocalDisks</a> API. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.AddWorkingStorageResponse) 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=Add-SGWorkingStorage.html&tocid=Add-SGWorkingStorage</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Disable-SGGateway</name> <description> <para>Invokes the DisableGateway operation against AWS Storage Gateway.</para> </description> <verb>Disable</verb> <noun>SGGateway</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway architectures. <important><para> Once a gateway is disabled it cannot be enabled. </para></important> </para> </description> <syntax> <syntaxItem> <name>Disable-SGGateway</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.DisableGatewayResponse) 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=Disable-SGGateway.html&tocid=Disable-SGGateway</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Enable-SGGateway</name> <description> <para>Invokes the ActivateGateway operation against AWS Storage Gateway.</para> </description> <verb>Enable</verb> <noun>SGGateway</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Activates the gateway you previously deployed on your host. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedActivateGateway-common.html"> Activate the AWS Storage Gateway</a>. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see <a>UpdateGatewayInformation</a>. You must turn on the gateway VM before you can activate your gateway. </para> </description> <syntax> <syntaxItem> <name>Enable-SGGateway</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivationKey</name> <description> <para>Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter <code>activationKey</code>. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the <code>ActivateGateway</code> API call determine the actual configuration of your gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>GatewayName</name> <description> <para>The name you configured for your gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>GatewayTimezone</name> <description> <para>A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>GatewayRegion</name> <description> <para>A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your <code>Host</code> header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>. Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1" </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>GatewayType</name> <description> <para>A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is <code>STORED</code>. Valid Values: "STORED", "CACHED", "VTL", "FILE_S3" </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MediumChangerType</name> <description> <para>The value that indicates the type of medium changer to use for tape gateway. This field is optional. Valid Values: "STK-L700", "AWS-Gateway-VTL" </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeDriveType</name> <description> <para>The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5" </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivationKey</name> <description> <para>Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter <code>activationKey</code>. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the <code>ActivateGateway</code> API call determine the actual configuration of your gateway. </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="False" 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="False" position="2"> <name>GatewayName</name> <description> <para>The name you configured for your gateway. </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="False" position="4"> <name>GatewayRegion</name> <description> <para>A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your <code>Host</code> header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>. Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1" </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="False" position="3"> <name>GatewayTimezone</name> <description> <para>A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule. </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="False" position="5"> <name>GatewayType</name> <description> <para>A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is <code>STORED</code>. Valid Values: "STORED", "CACHED", "VTL", "FILE_S3" </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="False" position="Named"> <name>MediumChangerType</name> <description> <para>The value that indicates the type of medium changer to use for tape gateway. This field is optional. Valid Values: "STK-L700", "AWS-Gateway-VTL" </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="False" position="Named"> <name>TapeDriveType</name> <description> <para>The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5" </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.ActivateGatewayResponse) 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=Enable-SGGateway.html&tocid=Enable-SGGateway</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGBandwidthRateLimit</name> <description> <para>Invokes the DescribeBandwidthRateLimit operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGBandwidthRateLimit</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </description> <syntax> <syntaxItem> <name>Get-SGBandwidthRateLimit</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.DescribeBandwidthRateLimitResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.DescribeBandwidthRateLimitResponse 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-SGBandwidthRateLimit.html&tocid=Get-SGBandwidthRateLimit</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGCache</name> <description> <para>Invokes the DescribeCache operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGCache</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the cache of a gateway. This operation is only supported in the cached volume,tape and file gateway architectures. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. </para> </description> <syntax> <syntaxItem> <name>Get-SGCache</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.DescribeCacheResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.DescribeCacheResponse 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-SGCache.html&tocid=Get-SGCache</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGCachediSCSIVolume</name> <description> <para>Invokes the DescribeCachediSCSIVolumes operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGCachediSCSIVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway architecture. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). </para> </description> <syntax> <syntaxItem> <name>Get-SGCachediSCSIVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>VolumeARNs</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>VolumeARNs</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.CachediSCSIVolume</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of CachediSCSIVolume objects. The service call response (type Amazon.StorageGateway.Model.DescribeCachediSCSIVolumesResponse) 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-SGCachediSCSIVolume.html&tocid=Get-SGCachediSCSIVolume</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGChapCredential</name> <description> <para>Invokes the DescribeChapCredentials operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGChapCredential</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. </para> </description> <syntax> <syntaxItem> <name>Get-SGChapCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TargetARN</name> <description> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TargetARN</name> <description> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN. </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.StorageGateway.Model.ChapInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ChapInfo objects. The service call response (type Amazon.StorageGateway.Model.DescribeChapCredentialsResponse) 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-SGChapCredential.html&tocid=Get-SGChapCredential</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGFileShareList</name> <description> <para>Invokes the ListFileShares operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGFileShareList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported in the file gateway architecture.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGFileShareList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>Opaque pagination token returned from a previous ListFileShares operation. If present, <code>Marker</code> specifies where to continue the list from after a previous call to ListFileShares. Optional. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed. </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="False" position="Named"> <name>Limit</name> <description> <para>The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>Opaque pagination token returned from a previous ListFileShares operation. If present, <code>Marker</code> specifies where to continue the list from after a previous call to ListFileShares. Optional. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.StorageGateway.Model.FileShareInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of FileShareInfo objects. The service call response (type Amazon.StorageGateway.Model.ListFileSharesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String), NextMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGFileShareList.html&tocid=Get-SGFileShareList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGGateway</name> <description> <para>Invokes the ListGateways operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGGateway</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGGateway</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the list of gateways returned be limited to the specified number of items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin the returned list of gateways. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the list of gateways returned be limited to the specified number of items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin the returned list of gateways. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.StorageGateway.Model.GatewayInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of GatewayInfo objects. The service call response (type Amazon.StorageGateway.Model.ListGatewaysResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGGateway.html&tocid=Get-SGGateway</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGGatewayInformation</name> <description> <para>Invokes the DescribeGatewayInformation operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGGatewayInformation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </description> <syntax> <syntaxItem> <name>Get-SGGatewayInformation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.DescribeGatewayInformationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.DescribeGatewayInformationResponse 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-SGGatewayInformation.html&tocid=Get-SGGatewayInformation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGLocalDisk</name> <description> <para>Invokes the ListLocalDisks operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGLocalDisk</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a <code>DiskStatus</code> field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). </para> </description> <syntax> <syntaxItem> <name>Get-SGLocalDisk</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.ListLocalDisksResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.ListLocalDisksResponse 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-SGLocalDisk.html&tocid=Get-SGLocalDisk</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGMaintenanceStartTime</name> <description> <para>Invokes the DescribeMaintenanceStartTime operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGMaintenanceStartTime</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. </para> </description> <syntax> <syntaxItem> <name>Get-SGMaintenanceStartTime</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.DescribeMaintenanceStartTimeResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.DescribeMaintenanceStartTimeResponse 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-SGMaintenanceStartTime.html&tocid=Get-SGMaintenanceStartTime</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGNFSFileShareList</name> <description> <para>Invokes the DescribeNFSFileShares operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGNFSFileShareList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets a description for one or more file shares from a file gateway. This operation is only supported in file gateways. </para> </description> <syntax> <syntaxItem> <name>Get-SGNFSFileShareList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FileShareARNList</name> <description> <para>An array containing the Amazon Resource Name (ARN) of each file share to be described. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FileShareARNList</name> <description> <para>An array containing the Amazon Resource Name (ARN) of each file share to be described. </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.StorageGateway.Model.NFSFileShareInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of NFSFileShareInfo objects. The service call response (type Amazon.StorageGateway.Model.DescribeNFSFileSharesResponse) 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-SGNFSFileShareList.html&tocid=Get-SGNFSFileShareList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGResourceTag</name> <description> <para>Invokes the ListTagsForResource operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway architecture.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceARN</name> <description> <para>The Amazon Resource Name (ARN) of the resource for which you want to list tags. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the list of tags returned be limited to the specified number of items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin returning the list of tags. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the list of tags returned be limited to the specified number of items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin returning the list of tags. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ResourceARN</name> <description> <para>The Amazon Resource Name (ARN) of the resource for which you want to list tags. </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.StorageGateway.Model.Tag</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Tag objects. The service call response (type Amazon.StorageGateway.Model.ListTagsForResourceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String), ResourceARN (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGResourceTag.html&tocid=Get-SGResourceTag</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGSnapshotSchedule</name> <description> <para>Invokes the DescribeSnapshotSchedule operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGSnapshotSchedule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume architectures. </para> </description> <syntax> <syntaxItem> <name>Get-SGSnapshotSchedule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes. </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.StorageGateway.Model.DescribeSnapshotScheduleResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.DescribeSnapshotScheduleResponse 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-SGSnapshotSchedule.html&tocid=Get-SGSnapshotSchedule</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGStorediSCSIVolume</name> <description> <para>Invokes the DescribeStorediSCSIVolumes operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGStorediSCSIVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway architecture. </para> </description> <syntax> <syntaxItem> <name>Get-SGStorediSCSIVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>VolumeARNs</name> <description> <para>An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>VolumeARNs</name> <description> <para>An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a gateway. </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.StorageGateway.Model.StorediSCSIVolume</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of StorediSCSIVolume objects. The service call response (type Amazon.StorageGateway.Model.DescribeStorediSCSIVolumesResponse) 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-SGStorediSCSIVolume.html&tocid=Get-SGStorediSCSIVolume</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGTape</name> <description> <para>Invokes the ListTapes operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGTape</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS. This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the <code>Limit</code> parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a <code>Marker</code> element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway architecture. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGTape</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeARNs</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>An optional number limit for the tapes in the list returned by this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>A string that indicates the position at which to begin the returned list of tapes. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>An optional number limit for the tapes in the list returned by this call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>A string that indicates the position at which to begin the returned list of tapes. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>TapeARNs</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.TapeInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TapeInfo objects. The service call response (type Amazon.StorageGateway.Model.ListTapesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGTape.html&tocid=Get-SGTape</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGTapeArchive</name> <description> <para>Invokes the RetrieveTapeArchive operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGTapeArchive</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway architecture. Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway architecture. </para> </description> <syntax> <syntaxItem> <name>Get-SGTapeArchive</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region. You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region. You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway. </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="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS). </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.RetrieveTapeArchiveResponse) 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-SGTapeArchive.html&tocid=Get-SGTapeArchive</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGTapeArchiveList</name> <description> <para>Invokes the DescribeTapeArchives operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGTapeArchiveList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture. If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGTapeArchiveList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TapeARNs</name> <description> <para>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the number of virtual tapes descried be limited to the specified number. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin describing virtual tapes. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the number of virtual tapes descried be limited to the specified number. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin describing virtual tapes. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>TapeARNs</name> <description> <para>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. </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.StorageGateway.Model.TapeArchive</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TapeArchive objects. The service call response (type Amazon.StorageGateway.Model.DescribeTapeArchivesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGTapeArchiveList.html&tocid=Get-SGTapeArchiveList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGTapeList</name> <description> <para>Invokes the DescribeTapes operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGTapeList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway architecture.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGTapeList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeARNs</name> <description> <para>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the number of virtual tapes described be limited to the specified number. Amazon Web Services may impose its own limit, if this field is not set. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>A marker value, obtained in a previous call to <code>DescribeTapes</code>. This marker indicates which page of results to retrieve. If not specified, the first page of results is retrieved. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the number of virtual tapes described be limited to the specified number. Amazon Web Services may impose its own limit, if this field is not set. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>A marker value, obtained in a previous call to <code>DescribeTapes</code>. This marker indicates which page of results to retrieve. If not specified, the first page of results is retrieved. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>TapeARNs</name> <description> <para>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway. </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.StorageGateway.Model.Tape</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Tape objects. The service call response (type Amazon.StorageGateway.Model.DescribeTapesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGTapeList.html&tocid=Get-SGTapeList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGTapeRecoveryPoint</name> <description> <para>Invokes the RetrieveTapeRecoveryPoint operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGTapeRecoveryPoint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway architecture. A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points. </para> </description> <syntax> <syntaxItem> <name>Get-SGTapeRecoveryPoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.RetrieveTapeRecoveryPointResponse) 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-SGTapeRecoveryPoint.html&tocid=Get-SGTapeRecoveryPoint</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGTapeRecoveryPointList</name> <description> <para>Invokes the DescribeTapeRecoveryPoints operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGTapeRecoveryPointList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of virtual tape recovery points that are available for the specified tape gateway. A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway architecture. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGTapeRecoveryPointList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the number of virtual tape recovery points that are described be limited to the specified number. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin describing the virtual tape recovery points. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the number of virtual tape recovery points that are described be limited to the specified number. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin describing the virtual tape recovery points. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.StorageGateway.Model.TapeRecoveryPointInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TapeRecoveryPointInfo objects. The service call response (type Amazon.StorageGateway.Model.DescribeTapeRecoveryPointsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: GatewayARN (type System.String), Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGTapeRecoveryPointList.html&tocid=Get-SGTapeRecoveryPointList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGUploadBuffer</name> <description> <para>Invokes the DescribeUploadBuffer operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGUploadBuffer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway architectures. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. </para> </description> <syntax> <syntaxItem> <name>Get-SGUploadBuffer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.DescribeUploadBufferResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.DescribeUploadBufferResponse 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-SGUploadBuffer.html&tocid=Get-SGUploadBuffer</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGVolume</name> <description> <para>Invokes the ListVolumes operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the <a>DescribeStorediSCSIVolumes</a> or the <a>DescribeCachediSCSIVolumes</a> API. The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the <code>Limit</code> field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway architectures. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the list of volumes returned be limited to the specified number of items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the list of volumes returned be limited to the specified number of items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.StorageGateway.Model.VolumeInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of VolumeInfo objects. The service call response (type Amazon.StorageGateway.Model.ListVolumesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: GatewayARN (type System.String), Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGVolume.html&tocid=Get-SGVolume</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGVolumeInitiatorList</name> <description> <para>Invokes the ListVolumeInitiators operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGVolumeInitiatorList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway architecture. </para> </description> <syntax> <syntaxItem> <name>Get-SGVolumeInitiatorList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes for the gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes for the gateway. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.StorageGateway.Model.ListVolumeInitiatorsResponse) 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-SGVolumeInitiatorList.html&tocid=Get-SGVolumeInitiatorList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGVolumeRecoveryPoint</name> <description> <para>Invokes the ListVolumeRecoveryPoints operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGVolumeRecoveryPoint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway architecture. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation. </para> </description> <syntax> <syntaxItem> <name>Get-SGVolumeRecoveryPoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.ListVolumeRecoveryPointsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.ListVolumeRecoveryPointsResponse 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-SGVolumeRecoveryPoint.html&tocid=Get-SGVolumeRecoveryPoint</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGVTLDevice</name> <description> <para>Invokes the DescribeVTLDevices operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGVTLDevice</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information. This operation is only supported in the tape gateway architecture. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SGVTLDevice</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VTLDeviceARNs</name> <description> <para>An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the number of VTL devices described be limited to the specified number. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin describing the VTL devices. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Limit</name> <description> <para>Specifies that the number of VTL devices described be limited to the specified number. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An opaque string that indicates the position at which to begin describing the VTL devices. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>VTLDeviceARNs</name> <description> <para>An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway. </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.StorageGateway.Model.VTLDevice</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of VTLDevice objects. The service call response (type Amazon.StorageGateway.Model.DescribeVTLDevicesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: GatewayARN (type System.String), Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SGVTLDevice.html&tocid=Get-SGVTLDevice</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SGWorkingStorage</name> <description> <para>Invokes the DescribeWorkingStorage operation against AWS Storage Gateway.</para> </description> <verb>Get</verb> <noun>SGWorkingStorage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway architecture. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. </para> </description> <syntax> <syntaxItem> <name>Get-SGWorkingStorage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.DescribeWorkingStorageResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.DescribeWorkingStorageResponse 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-SGWorkingStorage.html&tocid=Get-SGWorkingStorage</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Invoke-SGCacheRefresh</name> <description> <para>Invokes the RefreshCache operation against AWS Storage Gateway.</para> </description> <verb>Invoke</verb> <noun>SGCacheRefresh</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. </para> </description> <syntax> <syntaxItem> <name>Invoke-SGCacheRefresh</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>FileShareARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>FileShareARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.RefreshCacheResponse) 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=Invoke-SGCacheRefresh.html&tocid=Invoke-SGCacheRefresh</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>New-SGCachediSCSIVolume</name> <description> <para>Invokes the CreateCachediSCSIVolume operation against AWS Storage Gateway.</para> </description> <verb>New</verb> <noun>SGCachediSCSIVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway architecture. Cache storage must be allocated to the gateway before you can create a cached volume. Use the <a>AddCache</a> operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the <code>SourceVolumeARN</code> for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The <code>VolumeSizeInBytes</code> value must be equal to or larger than the size of the copied volume, in bytes. </para> </description> <syntax> <syntaxItem> <name>New-SGCachediSCSIVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>SnapshotId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>TargetName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <name>NetworkInterfaceId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="6"> <name>ClientToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceVolumeARN</name> <description> <para>The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The <code>VolumeSizeInBytes</code> value for this new volume must be equal to or larger than the size of the existing volume, in bytes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VolumeSizeInBytes</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="6"> <name>ClientToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="5"> <name>NetworkInterfaceId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="3"> <name>SnapshotId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>SourceVolumeARN</name> <description> <para>The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The <code>VolumeSizeInBytes</code> value for this new volume must be equal to or larger than the size of the existing volume, in bytes. </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="False" position="4"> <name>TargetName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>VolumeSizeInBytes</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.StorageGateway.Model.CreateCachediSCSIVolumeResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.CreateCachediSCSIVolumeResponse 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=New-SGCachediSCSIVolume.html&tocid=New-SGCachediSCSIVolume</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>New-SGNFSFileShare</name> <description> <para>Invokes the CreateNFSFileShare operation against AWS Storage Gateway.</para> </description> <verb>New</verb> <noun>SGNFSFileShare</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a Network File System (NFS) interface. This operation is only supported in the file gateway architecture. <important><para> File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. </para><para> File gateway does not support creating hard or symbolic links on a file share. </para></important> </para> </description> <syntax> <syntaxItem> <name>New-SGNFSFileShare</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientList</name> <description> <para>The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>A unique string value that you supply that is used by file gateway to ensure idempotent file share creation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultStorageClass</name> <description> <para>The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_DirectoryMode</name> <description> <para>The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_FileMode</name> <description> <para>The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_GroupId</name> <description> <para>The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KMSEncrypted</name> <description> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KMSKey</name> <description> <para>The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LocationARN</name> <description> <para>The ARN of the backed storage used for storing file data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_OwnerId</name> <description> <para>The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReadOnly</name> <description> <para>Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false". </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Role</name> <description> <para>The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Squash</name> <description> <para>Maps a user to anonymous user. Valid options are the following: - "RootSquash" - Only root is mapped to anonymous user. - "NoSquash" - No one is mapped to anonymous user. - "AllSquash" - Everyone is mapped to anonymous user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientList</name> <description> <para>The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. </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="False" position="Named"> <name>ClientToken</name> <description> <para>A unique string value that you supply that is used by file gateway to ensure idempotent file share creation. </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="False" position="Named"> <name>DefaultStorageClass</name> <description> <para>The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share. </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="False" position="Named"> <name>KMSEncrypted</name> <description> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KMSKey</name> <description> <para>The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional. </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="False" position="Named"> <name>LocationARN</name> <description> <para>The ARN of the backed storage used for storing file data. </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="False" position="Named"> <name>NFSFileShareDefaults_DirectoryMode</name> <description> <para>The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777. </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="False" position="Named"> <name>NFSFileShareDefaults_FileMode</name> <description> <para>The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666. </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="False" position="Named"> <name>NFSFileShareDefaults_GroupId</name> <description> <para>The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_OwnerId</name> <description> <para>The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReadOnly</name> <description> <para>Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false". </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Role</name> <description> <para>The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage. </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="False" position="Named"> <name>Squash</name> <description> <para>Maps a user to anonymous user. Valid options are the following: - "RootSquash" - Only root is mapped to anonymous user. - "NoSquash" - No one is mapped to anonymous user. - "AllSquash" - Everyone is mapped to anonymous user. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.CreateNFSFileShareResponse) 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=New-SGNFSFileShare.html&tocid=New-SGNFSFileShare</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>New-SGSnapshot</name> <description> <para>Invokes the CreateSnapshot operation against AWS Storage Gateway.</para> </description> <verb>New</verb> <noun>SGSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Initiates a snapshot of a volume. AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot">Editing a Snapshot Schedule</a>. In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway architecture. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html">EC2 API reference</a>. <important><para> Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the <a href="http://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html">Welcome</a> page. </para></important> </para> </description> <syntax> <syntaxItem> <name>New-SGSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SnapshotDescription</name> <description> <para>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the <b>Description</b> field, and in the AWS Storage Gateway snapshot <b>Details</b> pane, <b>Description</b> field </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>SnapshotDescription</name> <description> <para>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the <b>Description</b> field, and in the AWS Storage Gateway snapshot <b>Details</b> pane, <b>Description</b> field </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 (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes. </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.StorageGateway.Model.CreateSnapshotResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.CreateSnapshotResponse 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=New-SGSnapshot.html&tocid=New-SGSnapshot</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>New-SGSnapshotFromVolumeRecoveryPoint</name> <description> <para>Invokes the CreateSnapshotFromVolumeRecoveryPoint operation against AWS Storage Gateway.</para> </description> <verb>New</verb> <noun>SGSnapshotFromVolumeRecoveryPoint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway architecture. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use <a>ListVolumeRecoveryPoints</a>. In the <code>CreateSnapshotFromVolumeRecoveryPoint</code> request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in <i>Amazon Elastic Compute Cloud API Reference</i>. </para> </description> <syntax> <syntaxItem> <name>New-SGSnapshotFromVolumeRecoveryPoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SnapshotDescription</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>SnapshotDescription</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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 (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.CreateSnapshotFromVolumeRecoveryPointResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.CreateSnapshotFromVolumeRecoveryPointResponse 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=New-SGSnapshotFromVolumeRecoveryPoint.html&tocid=New-SGSnapshotFromVolumeRecoveryPoint</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>New-SGStorediSCSIVolume</name> <description> <para>Invokes the CreateStorediSCSIVolume operation against AWS Storage Gateway.</para> </description> <verb>New</verb> <noun>SGStorediSCSIVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway architecture. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para> </description> <syntax> <syntaxItem> <name>New-SGStorediSCSIVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>SnapshotId</name> <description> <para>The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>TargetName</name> <description> <para>The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5"> <name>NetworkInterfaceId</name> <description> <para>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DiskId</name> <description> <para>The unique identifier for the gateway local disk that is configured as a stored volume. Use <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html">ListLocalDisks</a> to list disk IDs for a gateway. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreserveExistingData</name> <description> <para>Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume. Valid Values: true, false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DiskId</name> <description> <para>The unique identifier for the gateway local disk that is configured as a stored volume. Use <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html">ListLocalDisks</a> to list disk IDs for a gateway. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="5"> <name>NetworkInterfaceId</name> <description> <para>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address. </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="False" position="Named"> <name>PreserveExistingData</name> <description> <para>Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume. Valid Values: true, false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>SnapshotId</name> <description> <para>The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>. </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="False" position="4"> <name>TargetName</name> <description> <para>The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway. </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.StorageGateway.Model.CreateStorediSCSIVolumeResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.CreateStorediSCSIVolumeResponse 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=New-SGStorediSCSIVolume.html&tocid=New-SGStorediSCSIVolume</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>New-SGTape</name> <description> <para>Invokes the CreateTapes operation against AWS Storage Gateway.</para> </description> <verb>New</verb> <noun>SGTape</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway architecture. Cache storage must be allocated to the gateway before you can create virtual tapes. Use the <a>AddCache</a> operation to add cache storage to a gateway. </para> </description> <syntax> <syntaxItem> <name>New-SGTape</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>A unique identifier that you use to retry a request. If you retry a request, use the same <code>ClientToken</code> you specified in the initial request. Using the same <code>ClientToken</code> prevents creating the tape multiple times. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NumTapesToCreate</name> <description> <para>The number of virtual tapes that you want to create. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeBarcodePrefix</name> <description> <para>A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique. The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeSizeInBytes</name> <description> <para>The size, in bytes, of the virtual tapes that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte). </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>A unique identifier that you use to retry a request. If you retry a request, use the same <code>ClientToken</code> you specified in the initial request. Using the same <code>ClientToken</code> prevents creating the tape multiple times. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region. </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="False" position="Named"> <name>NumTapesToCreate</name> <description> <para>The number of virtual tapes that you want to create. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeBarcodePrefix</name> <description> <para>A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique. The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z. </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="False" position="Named"> <name>TapeSizeInBytes</name> <description> <para>The size, in bytes, of the virtual tapes that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte). </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.StorageGateway.Model.CreateTapesResponse) 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=New-SGTape.html&tocid=New-SGTape</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>New-SGTapeWithBarcode</name> <description> <para>Invokes the CreateTapeWithBarcode operation against AWS Storage Gateway.</para> </description> <verb>New</verb> <noun>SGTapeWithBarcode</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway. architecture. Cache storage must be allocated to the gateway before you can create a virtual tape. Use the <a>AddCache</a> operation to add cache storage to a gateway. </para> </description> <syntax> <syntaxItem> <name>New-SGTapeWithBarcode</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TapeBarcode</name> <description> <para>The barcode that you want to assign to the tape. Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeSizeInByte</name> <description> <para>The size, in bytes, of the virtual tape that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte). </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region. </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="False" position="2"> <name>TapeBarcode</name> <description> <para>The barcode that you want to assign to the tape. Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted. </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="False" position="Named"> <name>TapeSizeInByte</name> <description> <para>The size, in bytes, of the virtual tape that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte). </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.CreateTapeWithBarcodeResponse) 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=New-SGTapeWithBarcode.html&tocid=New-SGTapeWithBarcode</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGBandwidthRateLimit</name> <description> <para>Invokes the DeleteBandwidthRateLimit operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGBandwidthRateLimit</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </description> <syntax> <syntaxItem> <name>Remove-SGBandwidthRateLimit</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>BandwidthType</name> <description> <para>One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete. Valid Values: <code>Upload</code>, <code>Download</code>, <code>All</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>BandwidthType</name> <description> <para>One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete. Valid Values: <code>Upload</code>, <code>Download</code>, <code>All</code>. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.DeleteBandwidthRateLimitResponse) 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=Remove-SGBandwidthRateLimit.html&tocid=Remove-SGBandwidthRateLimit</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGChapCredential</name> <description> <para>Invokes the DeleteChapCredentials operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGChapCredential</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. </para> </description> <syntax> <syntaxItem> <name>Remove-SGChapCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TargetARN</name> <description> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>InitiatorName</name> <description> <para>The iSCSI initiator that connects to the target. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>InitiatorName</name> <description> <para>The iSCSI initiator that connects to the target. </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 (ByValue, ByPropertyName)" position="1"> <name>TargetARN</name> <description> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN. </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.StorageGateway.Model.DeleteChapCredentialsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.DeleteChapCredentialsResponse 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=Remove-SGChapCredential.html&tocid=Remove-SGChapCredential</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGFileShare</name> <description> <para>Invokes the DeleteFileShare operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGFileShare</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a file share from a file gateway. This operation is only supported in the file gateway architecture. </para> </description> <syntax> <syntaxItem> <name>Remove-SGFileShare</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FileShareARN</name> <description> <para>The Amazon Resource Name (ARN) of the file share to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ForceDelete</name> <description> <para>If set to true, deletes a file share immediately and aborts all data uploads to AWS. Otherwise the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process and the file share enters the FORCE_DELETING status. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FileShareARN</name> <description> <para>The Amazon Resource Name (ARN) of the file share to be deleted. </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="False" 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="False" position="Named"> <name>ForceDelete</name> <description> <para>If set to true, deletes a file share immediately and aborts all data uploads to AWS. Otherwise the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process and the file share enters the FORCE_DELETING status. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.DeleteFileShareResponse) 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=Remove-SGFileShare.html&tocid=Remove-SGFileShare</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGGateway</name> <description> <para>Invokes the DeleteGateway operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGGateway</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. <important><para> You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the <a href="http://aws.amazon.com/storagegateway"> AWS Storage Gateway Detail Page</a>. </para></important> </para> </description> <syntax> <syntaxItem> <name>Remove-SGGateway</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.DeleteGatewayResponse) 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=Remove-SGGateway.html&tocid=Remove-SGGateway</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGResourceTag</name> <description> <para>Invokes the RemoveTagsFromResource operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway architectures. </para> </description> <syntax> <syntaxItem> <name>Remove-SGResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceARN</name> <description> <para>The Amazon Resource Name (ARN) of the resource you want to remove the tags from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>ResourceARN</name> <description> <para>The Amazon Resource Name (ARN) of the resource you want to remove the tags from. </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="False" position="Named"> <name>TagKey</name> <description> <para>The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.RemoveTagsFromResourceResponse) 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=Remove-SGResourceTag.html&tocid=Remove-SGResourceTag</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGSnapshotSchedule</name> <description> <para>Invokes the DeleteSnapshotSchedule operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGSnapshotSchedule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html">Working with Snapshots</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the volume by providing its Amazon Resource Name (ARN). To list or delete a snapshot, you must use the Amazon EC2 API. in <i>Amazon Elastic Compute Cloud API Reference</i>. </para> </description> <syntax> <syntaxItem> <name>Remove-SGSnapshotSchedule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.DeleteSnapshotScheduleResponse) 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=Remove-SGSnapshotSchedule.html&tocid=Remove-SGSnapshotSchedule</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGTape</name> <description> <para>Invokes the DeleteTape operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGTape</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified virtual tape. This operation is only supported in the tape gateway architecture. </para> </description> <syntax> <syntaxItem> <name>Remove-SGTape</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region. </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="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape to delete. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.DeleteTapeResponse) 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=Remove-SGTape.html&tocid=Remove-SGTape</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGTapeArchive</name> <description> <para>Invokes the DeleteTapeArchive operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGTapeArchive</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway architecture. </para> </description> <syntax> <syntaxItem> <name>Remove-SGTapeArchive</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS). </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.DeleteTapeArchiveResponse) 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=Remove-SGTapeArchive.html&tocid=Remove-SGTapeArchive</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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-SGVolume</name> <description> <para>Invokes the DeleteVolume operation against AWS Storage Gateway.</para> </description> <verb>Remove</verb> <noun>SGVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified storage volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API. This operation is only supported in the cached volume and stored volume architectures. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. </para> </description> <syntax> <syntaxItem> <name>Remove-SGVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.DeleteVolumeResponse) 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=Remove-SGVolume.html&tocid=Remove-SGVolume</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Reset-SGCache</name> <description> <para>Invokes the ResetCache operation against AWS Storage Gateway.</para> </description> <verb>Reset</verb> <noun>SGCache</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume,tape and file gateway architectures. <important><para> If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. </para></important> </para> </description> <syntax> <syntaxItem> <name>Reset-SGCache</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the GatewayARN parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the GatewayARN parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the GatewayARN parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.StorageGateway.Model.ResetCacheResponse) 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=Reset-SGCache.html&tocid=Reset-SGCache</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Set-SGLocalConsolePassword</name> <description> <para>Invokes the SetLocalConsolePassword operation against AWS Storage Gateway.</para> </description> <verb>Set</verb> <noun>SGLocalConsolePassword</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password. </para> </description> <syntax> <syntaxItem> <name>Set-SGLocalConsolePassword</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LocalConsolePassword</name> <description> <para>The password you want to set for your VM local console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>LocalConsolePassword</name> <description> <para>The password you want to set for your VM local console. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.SetLocalConsolePasswordResponse) 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=Set-SGLocalConsolePassword.html&tocid=Set-SGLocalConsolePassword</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Start-SGGateway</name> <description> <para>Invokes the StartGateway operation against AWS Storage Gateway.</para> </description> <verb>Start</verb> <noun>SGGateway</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Starts a gateway that you previously shut down (see <a>ShutdownGateway</a>). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call <a>DescribeGatewayInformation</a> and check the status before making any additional API calls. For more information, see <a>ActivateGateway</a>. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </description> <syntax> <syntaxItem> <name>Start-SGGateway</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.StartGatewayResponse) 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=Start-SGGateway.html&tocid=Start-SGGateway</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Stop-SGArchival</name> <description> <para>Invokes the CancelArchival operation against AWS Storage Gateway.</para> </description> <verb>Stop</verb> <noun>SGArchival</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway architecture. </para> </description> <syntax> <syntaxItem> <name>Stop-SGArchival</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.CancelArchivalResponse) 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=Stop-SGArchival.html&tocid=Stop-SGArchival</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Stop-SGGateway</name> <description> <para>Invokes the ShutdownGateway operation against AWS Storage Gateway.</para> </description> <verb>Stop</verb> <noun>SGGateway</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM. If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. After the gateway is shutdown, you cannot call any other API except <a>StartGateway</a>, <a>DescribeGatewayInformation</a>, and <a>ListGateways</a>. For more information, see <a>ActivateGateway</a>. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. When you make a shutdown request, you will get a <code>200 OK</code> success response immediately. However, it might take some time for the gateway to shut down. You can call the <a>DescribeGatewayInformation</a> API to check the status. For more information, see <a>ActivateGateway</a>. If do not intend to use the gateway again, you must delete the gateway (using <a>DeleteGateway</a>) to no longer pay software charges associated with the gateway. </para> </description> <syntax> <syntaxItem> <name>Stop-SGGateway</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.ShutdownGatewayResponse) 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=Stop-SGGateway.html&tocid=Stop-SGGateway</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Stop-SGRetrieval</name> <description> <para>Invokes the CancelRetrieval operation against AWS Storage Gateway.</para> </description> <verb>Stop</verb> <noun>SGRetrieval</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. </para> </description> <syntax> <syntaxItem> <name>Stop-SGRetrieval</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>TapeARN</name> <description> <para>The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.CancelRetrievalResponse) 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=Stop-SGRetrieval.html&tocid=Stop-SGRetrieval</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Update-SGBandwidthRateLimit</name> <description> <para>Invokes the UpdateBandwidthRateLimit operation against AWS Storage Gateway.</para> </description> <verb>Update</verb> <noun>SGBandwidthRateLimit</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </description> <syntax> <syntaxItem> <name>Update-SGBandwidthRateLimit</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AverageUploadRateLimitInBitsPerSec</name> <description> <para>The average upload bandwidth rate limit in bits per second. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AverageDownloadRateLimitInBitsPerSec</name> <description> <para>The average download bandwidth rate limit in bits per second. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AverageDownloadRateLimitInBitsPerSec</name> <description> <para>The average download bandwidth rate limit in bits per second. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AverageUploadRateLimitInBitsPerSec</name> <description> <para>The average upload bandwidth rate limit in bits per second. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.UpdateBandwidthRateLimitResponse) 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=Update-SGBandwidthRateLimit.html&tocid=Update-SGBandwidthRateLimit</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Update-SGChapCredential</name> <description> <para>Invokes the UpdateChapCredentials operation against AWS Storage Gateway.</para> </description> <verb>Update</verb> <noun>SGChapCredential</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. <important><para> When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. </para></important> </para> </description> <syntax> <syntaxItem> <name>Update-SGChapCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TargetARN</name> <description> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return the TargetARN for specified VolumeARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SecretToAuthenticateInitiator</name> <description> <para>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. The secret key must be between 12 and 16 bytes when encoded in UTF-8. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>InitiatorName</name> <description> <para>The iSCSI initiator that connects to the target. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>SecretToAuthenticateTarget</name> <description> <para>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). Byte constraints: Minimum bytes of 12. Maximum bytes of 16. The secret key must be between 12 and 16 bytes when encoded in UTF-8. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="3"> <name>InitiatorName</name> <description> <para>The iSCSI initiator that connects to the target. </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="False" position="2"> <name>SecretToAuthenticateInitiator</name> <description> <para>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. The secret key must be between 12 and 16 bytes when encoded in UTF-8. </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="False" position="4"> <name>SecretToAuthenticateTarget</name> <description> <para>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). Byte constraints: Minimum bytes of 12. Maximum bytes of 16. The secret key must be between 12 and 16 bytes when encoded in UTF-8. </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 (ByValue, ByPropertyName)" position="1"> <name>TargetARN</name> <description> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return the TargetARN for specified VolumeARN. </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.StorageGateway.Model.UpdateChapCredentialsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.UpdateChapCredentialsResponse 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=Update-SGChapCredential.html&tocid=Update-SGChapCredential</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Update-SGGatewayInformation</name> <description> <para>Invokes the UpdateGatewayInformation operation against AWS Storage Gateway.</para> </description> <verb>Update</verb> <noun>SGGatewayInformation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN. </para> </description> <syntax> <syntaxItem> <name>Update-SGGatewayInformation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>GatewayName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>GatewayTimezone</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="2"> <name>GatewayName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="3"> <name>GatewayTimezone</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.StorageGateway.Model.UpdateGatewayInformationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StorageGateway.Model.UpdateGatewayInformationResponse 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=Update-SGGatewayInformation.html&tocid=Update-SGGatewayInformation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Update-SGGatewaySoftwareNow</name> <description> <para>Invokes the UpdateGatewaySoftwareNow operation against AWS Storage Gateway.</para> </description> <verb>Update</verb> <noun>SGGatewaySoftwareNow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete. You can call <a>DescribeGatewayInformation</a> to verify the gateway is in the <code>STATE_RUNNING</code> state. <important><para> A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings">Customizing Your Windows iSCSI Settings</a> and <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings">Customizing Your Linux iSCSI Settings</a>, respectively. </para></important> </para> </description> <syntax> <syntaxItem> <name>Update-SGGatewaySoftwareNow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.UpdateGatewaySoftwareNowResponse) 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=Update-SGGatewaySoftwareNow.html&tocid=Update-SGGatewaySoftwareNow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Update-SGMaintenanceStartTime</name> <description> <para>Invokes the UpdateMaintenanceStartTime operation against AWS Storage Gateway.</para> </description> <verb>Update</verb> <noun>SGMaintenanceStartTime</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. </para> </description> <syntax> <syntaxItem> <name>Update-SGMaintenanceStartTime</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>HourOfDay</name> <description> <para>The hour component of the maintenance start time represented as <i>hh</i>, where <i>hh</i> is the hour (00 to 23). The hour of the day is in the time zone of the gateway. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>MinuteOfHour</name> <description> <para>The minute component of the maintenance start time represented as <i>mm</i>, where <i>mm</i> is the minute (00 to 59). The minute of the hour is in the time zone of the gateway. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>DayOfWeek</name> <description> <para>The maintenance start time day of the week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>DayOfWeek</name> <description> <para>The maintenance start time day of the week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>GatewayARN</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="2"> <name>HourOfDay</name> <description> <para>The hour component of the maintenance start time represented as <i>hh</i>, where <i>hh</i> is the hour (00 to 23). The hour of the day is in the time zone of the gateway. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>MinuteOfHour</name> <description> <para>The minute component of the maintenance start time represented as <i>mm</i>, where <i>mm</i> is the minute (00 to 59). The minute of the hour is in the time zone of the gateway. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.UpdateMaintenanceStartTimeResponse) 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=Update-SGMaintenanceStartTime.html&tocid=Update-SGMaintenanceStartTime</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Update-SGNFSFileShare</name> <description> <para>Invokes the UpdateNFSFileShare operation against AWS Storage Gateway.</para> </description> <verb>Update</verb> <noun>SGNFSFileShare</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a file share. This operation is only supported in the file gateway architecture. To leave a file share field unchanged, set the corresponding input field to null. Updates the following file share setting: - Default storage class for your S3 bucket - Metadata defaults for your S3 bucket - Allowed NFS clients for your file share - Squash settings - Write status of your file share To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways. </para> </description> <syntax> <syntaxItem> <name>Update-SGNFSFileShare</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientList</name> <description> <para>The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultStorageClass</name> <description> <para>The default storage class for objects put into an Amazon S3 bucket by a file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_DirectoryMode</name> <description> <para>The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_FileMode</name> <description> <para>The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FileShareARN</name> <description> <para>The Amazon Resource Name (ARN) of the file share to be updated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_GroupId</name> <description> <para>The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KMSEncrypted</name> <description> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KMSKey</name> <description> <para>The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_OwnerId</name> <description> <para>The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReadOnly</name> <description> <para>Sets the write status of a file share: "true" if the write status is read-only, otherwise "false". </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Squash</name> <description> <para>The user mapped to anonymous user. Valid options are the following: - "RootSquash" - Only root is mapped to anonymous user. - "NoSquash" - No one is mapped to anonymous user - "AllSquash" - Everyone is mapped to anonymous user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientList</name> <description> <para>The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. </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="False" position="Named"> <name>DefaultStorageClass</name> <description> <para>The default storage class for objects put into an Amazon S3 bucket by a file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional. </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>FileShareARN</name> <description> <para>The Amazon Resource Name (ARN) of the file share to be updated. </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="False" 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="False" position="Named"> <name>KMSEncrypted</name> <description> <para>True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KMSKey</name> <description> <para>The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional. </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="False" position="Named"> <name>NFSFileShareDefaults_DirectoryMode</name> <description> <para>The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777. </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="False" position="Named"> <name>NFSFileShareDefaults_FileMode</name> <description> <para>The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666. </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="False" position="Named"> <name>NFSFileShareDefaults_GroupId</name> <description> <para>The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NFSFileShareDefaults_OwnerId</name> <description> <para>The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReadOnly</name> <description> <para>Sets the write status of a file share: "true" if the write status is read-only, otherwise "false". </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Squash</name> <description> <para>The user mapped to anonymous user. Valid options are the following: - "RootSquash" - Only root is mapped to anonymous user. - "NoSquash" - No one is mapped to anonymous user - "AllSquash" - Everyone is mapped to anonymous user. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.UpdateNFSFileShareResponse) 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=Update-SGNFSFileShare.html&tocid=Update-SGNFSFileShare</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Update-SGSnapshotSchedule</name> <description> <para>Invokes the UpdateSnapshotSchedule operation against AWS Storage Gateway.</para> </description> <verb>Update</verb> <noun>SGSnapshotSchedule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway architectures. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots. </para> </description> <syntax> <syntaxItem> <name>Update-SGSnapshotSchedule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>StartAt</name> <description> <para>The hour of the day at which the snapshot schedule begins represented as <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time zone of the gateway. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>RecurrenceInHours</name> <description> <para>Frequency of snapshots. Specify the number of hours between snapshots. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Description</name> <description> <para>Optional description of the snapshot that overwrites the existing description. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Description</name> <description> <para>Optional description of the snapshot that overwrites the existing description. </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="False" 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="False" position="3"> <name>RecurrenceInHours</name> <description> <para>Frequency of snapshots. Specify the number of hours between snapshots. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>StartAt</name> <description> <para>The hour of the day at which the snapshot schedule begins represented as <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time zone of the gateway. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>VolumeARN</name> <description> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.StorageGateway.Model.UpdateSnapshotScheduleResponse) 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=Update-SGSnapshotSchedule.html&tocid=Update-SGSnapshotSchedule</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Update-SGVTLDeviceType</name> <description> <para>Invokes the UpdateVTLDeviceType operation against AWS Storage Gateway.</para> </description> <verb>Update</verb> <noun>SGVTLDeviceType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway architecture. </para> </description> <syntax> <syntaxItem> <name>Update-SGVTLDeviceType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType</name> <description> <para>The type of medium changer you want to select. Valid Values: "STK-L700", "AWS-Gateway-VTL" </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VTLDeviceARN</name> <description> <para>The Amazon Resource Name (ARN) of the medium changer you want to select. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType</name> <description> <para>The type of medium changer you want to select. Valid Values: "STK-L700", "AWS-Gateway-VTL" </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="False" 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="False" position="Named"> <name>VTLDeviceARN</name> <description> <para>The Amazon Resource Name (ARN) of the medium changer you want to select. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.StorageGateway.Model.UpdateVTLDeviceTypeResponse) 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=Update-SGVTLDeviceType.html&tocid=Update-SGVTLDeviceType</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/storagegateway/latest/APIReference/</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>Get-SFNActivity</name> <description> <para>Invokes the DescribeActivity operation against Amazon Step Functions.</para> </description> <verb>Get</verb> <noun>SFNActivity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes an activity. </para> </description> <syntax> <syntaxItem> <name>Get-SFNActivity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivityArn</name> <description> <para>The Amazon Resource Name (ARN) of the activity to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivityArn</name> <description> <para>The Amazon Resource Name (ARN) of the activity to describe. </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.StepFunctions.Model.DescribeActivityResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StepFunctions.Model.DescribeActivityResponse 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-SFNActivity.html&tocid=Get-SFNActivity</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>Get-SFNActivityList</name> <description> <para>Invokes the ListActivities operation against Amazon Step Functions.</para> </description> <verb>Get</verb> <noun>SFNActivityList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextToken</code> returned by the previous call.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SFNActivityList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results that will be returned per call. <code>nextToken</code> can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>nextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextToken</code>. Keep all other arguments unchanged. The configured <code>maxResults</code> determines how many results can be returned in a single call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results that will be returned per call. <code>nextToken</code> can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>nextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextToken</code>. Keep all other arguments unchanged. The configured <code>maxResults</code> determines how many results can be returned in a single call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.StepFunctions.Model.ActivityListItem</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ActivityListItem objects. The service call response (type Amazon.StepFunctions.Model.ListActivitiesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SFNActivityList.html&tocid=Get-SFNActivityList</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>Get-SFNActivityTask</name> <description> <para>Invokes the GetActivityTask operation against Amazon Step Functions.</para> </description> <verb>Get</verb> <noun>SFNActivityTask</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result, that is, the <code>taskToken</code> returned is an empty string. <important><para> Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). </para></important> </para> </description> <syntax> <syntaxItem> <name>Get-SFNActivityTask</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivityArn</name> <description> <para>The Amazon Resource Name (ARN) of the activity to retrieve tasks from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WorkerName</name> <description> <para>An arbitrary name may be provided in order to identify the worker that the task is assigned to. This name will be used when it is logged in the execution history. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivityArn</name> <description> <para>The Amazon Resource Name (ARN) of the activity to retrieve tasks from. </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="False" position="Named"> <name>WorkerName</name> <description> <para>An arbitrary name may be provided in order to identify the worker that the task is assigned to. This name will be used when it is logged in the execution history. </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.StepFunctions.Model.GetActivityTaskResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StepFunctions.Model.GetActivityTaskResponse 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-SFNActivityTask.html&tocid=Get-SFNActivityTask</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>Get-SFNExecution</name> <description> <para>Invokes the DescribeExecution operation against Amazon Step Functions.</para> </description> <verb>Get</verb> <noun>SFNExecution</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes an execution. </para> </description> <syntax> <syntaxItem> <name>Get-SFNExecution</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ExecutionArn</name> <description> <para>The Amazon Resource Name (ARN) of the execution to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ExecutionArn</name> <description> <para>The Amazon Resource Name (ARN) of the execution to describe. </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.StepFunctions.Model.DescribeExecutionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StepFunctions.Model.DescribeExecutionResponse 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-SFNExecution.html&tocid=Get-SFNExecution</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>Get-SFNExecutionHistory</name> <description> <para>Invokes the GetExecutionHistory operation against Amazon Step Functions.</para> </description> <verb>Get</verb> <noun>SFNExecutionHistory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the <code>timeStamp</code> of the events. Use the <code>reverseOrder</code> parameter to get the latest events first. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextToken</code> returned by the previous call.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SFNExecutionHistory</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ExecutionArn</name> <description> <para>The Amazon Resource Name (ARN) of the execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReverseOrder</name> <description> <para>Lists events in descending order of their <code>timeStamp</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results that will be returned per call. <code>nextToken</code> can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>nextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextToken</code>. Keep all other arguments unchanged. The configured <code>maxResults</code> determines how many results can be returned in a single call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ExecutionArn</name> <description> <para>The Amazon Resource Name (ARN) of the execution. </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="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results that will be returned per call. <code>nextToken</code> can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>nextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextToken</code>. Keep all other arguments unchanged. The configured <code>maxResults</code> determines how many results can be returned in a single call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>ReverseOrder</name> <description> <para>Lists events in descending order of their <code>timeStamp</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.StepFunctions.Model.HistoryEvent</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HistoryEvent objects. The service call response (type Amazon.StepFunctions.Model.GetExecutionHistoryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SFNExecutionHistory.html&tocid=Get-SFNExecutionHistory</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>Get-SFNExecutionList</name> <description> <para>Invokes the ListExecutions operation against Amazon Step Functions.</para> </description> <verb>Get</verb> <noun>SFNExecutionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextToken</code> returned by the previous call.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SFNExecutionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>StateMachineArn</name> <description> <para>The Amazon Resource Name (ARN) of the state machine whose executions will be listed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StatusFilter</name> <description> <para>If specified, only list the executions whose current execution status matches the given filter. </para> </description> <parameterValue required="true" variableLength="false">Amazon.StepFunctions.ExecutionStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results that will be returned per call. <code>nextToken</code> can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>nextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextToken</code>. Keep all other arguments unchanged. The configured <code>maxResults</code> determines how many results can be returned in a single call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results that will be returned per call. <code>nextToken</code> can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>nextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextToken</code>. Keep all other arguments unchanged. The configured <code>maxResults</code> determines how many results can be returned in a single call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>StateMachineArn</name> <description> <para>The Amazon Resource Name (ARN) of the state machine whose executions will be listed. </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="False" position="Named"> <name>StatusFilter</name> <description> <para>If specified, only list the executions whose current execution status matches the given filter. </para> </description> <parameterValue required="true" variableLength="false">Amazon.StepFunctions.ExecutionStatus</parameterValue> <type> <name>Amazon.StepFunctions.ExecutionStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.StepFunctions.Model.ExecutionListItem</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ExecutionListItem objects. The service call response (type Amazon.StepFunctions.Model.ListExecutionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SFNExecutionList.html&tocid=Get-SFNExecutionList</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>Get-SFNStateMachine</name> <description> <para>Invokes the DescribeStateMachine operation against Amazon Step Functions.</para> </description> <verb>Get</verb> <noun>SFNStateMachine</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes a state machine. </para> </description> <syntax> <syntaxItem> <name>Get-SFNStateMachine</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>StateMachineArn</name> <description> <para>The Amazon Resource Name (ARN) of the state machine to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>StateMachineArn</name> <description> <para>The Amazon Resource Name (ARN) of the state machine to describe. </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.StepFunctions.Model.DescribeStateMachineResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StepFunctions.Model.DescribeStateMachineResponse 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-SFNStateMachine.html&tocid=Get-SFNStateMachine</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>Get-SFNStateMachineList</name> <description> <para>Invokes the ListStateMachines operation against Amazon Step Functions.</para> </description> <verb>Get</verb> <noun>SFNStateMachineList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextToken</code> returned by the previous call.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SFNStateMachineList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results that will be returned per call. <code>nextToken</code> can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>nextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextToken</code>. Keep all other arguments unchanged. The configured <code>maxResults</code> determines how many results can be returned in a single call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results that will be returned per call. <code>nextToken</code> can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>nextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>nextToken</code>. Keep all other arguments unchanged. The configured <code>maxResults</code> determines how many results can be returned in a single call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.StepFunctions.Model.StateMachineListItem</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of StateMachineListItem objects. The service call response (type Amazon.StepFunctions.Model.ListStateMachinesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SFNStateMachineList.html&tocid=Get-SFNStateMachineList</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>New-SFNActivity</name> <description> <para>Invokes the CreateActivity operation against Amazon Step Functions.</para> </description> <verb>New</verb> <noun>SFNActivity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an activity. </para> </description> <syntax> <syntaxItem> <name>New-SFNActivity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the activity to create. This name must be unique for your AWS account and region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the activity to create. This name must be unique for your AWS account and region. </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.StepFunctions.Model.CreateActivityResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StepFunctions.Model.CreateActivityResponse 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=New-SFNActivity.html&tocid=New-SFNActivity</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>New-SFNStateMachine</name> <description> <para>Invokes the CreateStateMachine operation against Amazon Step Functions.</para> </description> <verb>New</verb> <noun>SFNStateMachine</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a state machine. </para> </description> <syntax> <syntaxItem> <name>New-SFNStateMachine</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the state machine. This name must be unique for your AWS account and region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Definition</name> <description> <para>The Amazon States Language definition of the state machine. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the IAM role to use for this state machine. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Definition</name> <description> <para>The Amazon States Language definition of the state machine. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the state machine. This name must be unique for your AWS account and region. </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="False" position="Named"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the IAM role to use for this state machine. </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.StepFunctions.Model.CreateStateMachineResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StepFunctions.Model.CreateStateMachineResponse 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=New-SFNStateMachine.html&tocid=New-SFNStateMachine</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-SFNActivity</name> <description> <para>Invokes the DeleteActivity operation against Amazon Step Functions.</para> </description> <verb>Remove</verb> <noun>SFNActivity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an activity. </para> </description> <syntax> <syntaxItem> <name>Remove-SFNActivity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivityArn</name> <description> <para>The Amazon Resource Name (ARN) of the activity to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ActivityArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivityArn</name> <description> <para>The Amazon Resource Name (ARN) of the activity to delete. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ActivityArn parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ActivityArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.StepFunctions.Model.DeleteActivityResponse) 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-SFNActivity.html&tocid=Remove-SFNActivity</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-SFNStateMachine</name> <description> <para>Invokes the DeleteStateMachine operation against Amazon Step Functions.</para> </description> <verb>Remove</verb> <noun>SFNStateMachine</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process. </para> </description> <syntax> <syntaxItem> <name>Remove-SFNStateMachine</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>StateMachineArn</name> <description> <para>The Amazon Resource Name (ARN) of the state machine to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StateMachineArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StateMachineArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>StateMachineArn</name> <description> <para>The Amazon Resource Name (ARN) of the state machine to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the StateMachineArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.StepFunctions.Model.DeleteStateMachineResponse) 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-SFNStateMachine.html&tocid=Remove-SFNStateMachine</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-SFNTaskFailure</name> <description> <para>Invokes the SendTaskFailure operation against Amazon Step Functions.</para> </description> <verb>Send</verb> <noun>SFNTaskFailure</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used by workers to report that the task identified by the <code>taskToken</code> failed. </para> </description> <syntax> <syntaxItem> <name>Send-SFNTaskFailure</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TaskToken</name> <description> <para>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Cause</name> <description> <para>A more detailed explanation of the cause of the failure. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Error</name> <description> <para>An arbitrary error code that identifies the cause of the failure. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TaskToken parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Cause</name> <description> <para>A more detailed explanation of the cause of the failure. </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="False" position="Named"> <name>Error</name> <description> <para>An arbitrary error code that identifies the cause of the failure. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TaskToken parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>TaskToken</name> <description> <para>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken). </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TaskToken parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.StepFunctions.Model.SendTaskFailureResponse) 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-SFNTaskFailure.html&tocid=Send-SFNTaskFailure</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-SFNTaskHeartbeat</name> <description> <para>Invokes the SendTaskHeartbeat operation against Amazon Step Functions.</para> </description> <verb>Send</verb> <noun>SFNTaskHeartbeat</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used by workers to report to the service that the task represented by the specified <code>taskToken</code> is still making progress. This action resets the <code>Heartbeat</code> clock. The <code>Heartbeat</code> threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history will contain an <code>ActivityTimedOut</code> event. The <code>Timeout</code> of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of <a>SendTaskHeartbeat</a> requests received. This operation is only useful for long-lived tasks to report the liveliness of the task. </para> </description> <syntax> <syntaxItem> <name>Send-SFNTaskHeartbeat</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TaskToken</name> <description> <para>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TaskToken parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TaskToken parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>TaskToken</name> <description> <para>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken). </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TaskToken parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.StepFunctions.Model.SendTaskHeartbeatResponse) 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-SFNTaskHeartbeat.html&tocid=Send-SFNTaskHeartbeat</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-SFNTaskSuccess</name> <description> <para>Invokes the SendTaskSuccess operation against Amazon Step Functions.</para> </description> <verb>Send</verb> <noun>SFNTaskSuccess</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used by workers to report that the task identified by the <code>taskToken</code> completed successfully. </para> </description> <syntax> <syntaxItem> <name>Send-SFNTaskSuccess</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TaskToken</name> <description> <para>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Output</name> <description> <para>The JSON output of the task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TaskToken parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Output</name> <description> <para>The JSON output of the task. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TaskToken parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>TaskToken</name> <description> <para>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken). </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TaskToken parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.StepFunctions.Model.SendTaskSuccessResponse) 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-SFNTaskSuccess.html&tocid=Send-SFNTaskSuccess</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>Start-SFNExecution</name> <description> <para>Invokes the StartExecution operation against Amazon Step Functions.</para> </description> <verb>Start</verb> <noun>SFNExecution</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Starts a state machine execution. </para> </description> <syntax> <syntaxItem> <name>Start-SFNExecution</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>StateMachineArn</name> <description> <para>The Amazon Resource Name (ARN) of the state machine to execute. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Input</name> <description> <para>The JSON input data for the execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The name of the execution. This name must be unique for your AWS account and region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Input</name> <description> <para>The JSON input data for the execution. </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="False" position="Named"> <name>Name</name> <description> <para>The name of the execution. This name must be unique for your AWS account and region. </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 (ByValue, )" position="1"> <name>StateMachineArn</name> <description> <para>The Amazon Resource Name (ARN) of the state machine to execute. </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.StepFunctions.Model.StartExecutionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.StepFunctions.Model.StartExecutionResponse 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=Start-SFNExecution.html&tocid=Start-SFNExecution</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>Stop-SFNExecution</name> <description> <para>Invokes the StopExecution operation against Amazon Step Functions.</para> </description> <verb>Stop</verb> <noun>SFNExecution</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Stops an execution. </para> </description> <syntax> <syntaxItem> <name>Stop-SFNExecution</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ExecutionArn</name> <description> <para>The Amazon Resource Name (ARN) of the execution to stop. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Cause</name> <description> <para>A more detailed explanation of the cause of the termination. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Error</name> <description> <para>An arbitrary error code that identifies the cause of the termination. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Cause</name> <description> <para>A more detailed explanation of the cause of the termination. </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="False" position="Named"> <name>Error</name> <description> <para>An arbitrary error code that identifies the cause of the termination. </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 (ByValue, )" position="1"> <name>ExecutionArn</name> <description> <para>The Amazon Resource Name (ARN) of the execution to stop. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.DateTime</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DateTime object. The service call response (type Amazon.StepFunctions.Model.StopExecutionResponse) 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=Stop-SFNExecution.html&tocid=Stop-SFNExecution</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>Add-SQSPermission</name> <description> <para>Invokes the AddPermission operation against Amazon Simple Queue Service.</para> </description> <verb>Add</verb> <noun>SQSPermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds a permission to a queue for a specific <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. <code>AddPermission</code> writes an Amazon-SQS-generated policy. If you want to write your own policy, use <code><a>SetQueueAttributes</a></code> to upload your policy. For more information about writing your own policy, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AccessPolicyLanguage.html">Using The Access Policy Language</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: <code>&amp;Attribute.1=this</code> <code>&amp;Attribute.2=that</code> </para> </description> <syntax> <syntaxItem> <name>Add-SQSPermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue to which permissions are added. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Label</name> <description> <para>The unique identification of the permission you're setting (for example, <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AWSAccountId</name> <description> <para>The AWS account number of the <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a> who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html">Your AWS Identifiers</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Action</name> <description> <para>The action the client wants to allow for the specified principal. The following values are valid: - <code>*</code> - <code>ChangeMessageVisibility</code> - <code>DeleteMessage</code> - <code>GetQueueAttributes</code> - <code>GetQueueUrl</code> - <code>ReceiveMessage</code> - <code>SendMessage</code> For more information about these actions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes">Understanding Permissions</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or <code>ChangeMessageVisibility</code> for <code>ActionName.n</code> also grants permissions for the corresponding batch versions of those actions: <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and <code>ChangeMessageVisibilityBatch</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Action</name> <description> <para>The action the client wants to allow for the specified principal. The following values are valid: - <code>*</code> - <code>ChangeMessageVisibility</code> - <code>DeleteMessage</code> - <code>GetQueueAttributes</code> - <code>GetQueueUrl</code> - <code>ReceiveMessage</code> - <code>SendMessage</code> For more information about these actions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes">Understanding Permissions</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or <code>ChangeMessageVisibility</code> for <code>ActionName.n</code> also grants permissions for the corresponding batch versions of those actions: <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and <code>ChangeMessageVisibilityBatch</code>. </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="False" position="3"> <name>AWSAccountId</name> <description> <para>The AWS account number of the <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a> who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html">Your AWS Identifiers</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </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="False" 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="False" position="2"> <name>Label</name> <description> <para>The unique identification of the permission you're setting (for example, <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>). </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue to which permissions are added. Queue URLs are case-sensitive. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.AddPermissionResponse) 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=Add-SQSPermission.html&tocid=Add-SQSPermission</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Add-SQSPermission -Action SendMessage -AWSAccountId 80398EXAMPLE -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue</code><remarks><para>Description</para><para>-----------</para><para>This example allows the specified AWS account to send messages from the specified queue.</para><para /><para /></remarks> </example> </examples> </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>Add-SQSResourceTag</name> <description> <para>Invokes the TagQueue operation against Amazon Simple Queue Service.</para> </description> <verb>Add</verb> <noun>SQSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-tagging-queues.html">Tagging Amazon SQS Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. When you use queue tags, keep the following guidelines in mind: - Adding more than 50 tags to a queue isn't recommended. - Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. - Tags are case-sensitive. - A new tag with a key identical to that of an existing tag overwrites the existing tag. - Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=technical">technical support request</a>. For a full list of tag restrictions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">Limits Related to Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Add-SQSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the queue. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>The list of tags to be added to the specified queue. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the queue. </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="False" position="Named"> <name>Tag</name> <description> <para>The list of tags to be added to the specified queue. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.TagQueueResponse) 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=Add-SQSResourceTag.html&tocid=Add-SQSResourceTag</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</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>Clear-SQSQueue</name> <description> <para>Invokes the PurgeQueue operation against Amazon Simple Queue Service.</para> </description> <verb>Clear</verb> <noun>SQSQueue</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the messages in a queue specified by the <code>QueueURL</code> parameter. <important><para> When you use the <code>PurgeQueue</code> action, you can't retrieve a message deleted from a queue. </para></important> When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the <code>PurgeQueue</code> action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before <code>PurgeQueue</code> is called might be received, but are deleted within the next minute. </para> </description> <syntax> <syntaxItem> <name>Clear-SQSQueue</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the queue from which the <code>PurgeQueue</code> action deletes messages. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the queue from which the <code>PurgeQueue</code> action deletes messages. Queue URLs are case-sensitive. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.PurgeQueueResponse) 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=Clear-SQSQueue.html&tocid=Clear-SQSQueue</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Clear-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue</code><remarks><para>Description</para><para>-----------</para><para>This example deletes all messages from the specified queue.</para><para /><para /></remarks> </example> </examples> </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>Edit-SQSMessageVisibility</name> <description> <para>Invokes the ChangeMessageVisibility operation against Amazon Simple Queue Service.</para> </description> <verb>Edit</verb> <noun>SQSMessageVisibility</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call <code>ChangeMessageVisiblity</code> with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the <code>ChangeMessageVisibility</code> action. This results in a total visibility timeout of 13 minutes. You can continue to call the <code>ChangeMessageVisibility</code> to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected. A message is considered to be <i>in flight</i> after it's received from a queue by a consumer, but not yet deleted from the queue. For standard queues, there can be a maximum of 120,000 inflight messages per queue. If you reach this limit, Amazon SQS returns the <code>OverLimit</code> error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages. <important><para> If you attempt to set the <code>VisibilityTimeout</code> to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time. </para><para> Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the <code>ChangeMessageVisibility</code> action) the next time the message is received. </para></important> </para> </description> <syntax> <syntaxItem> <name>Edit-SQSMessageVisibility</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>ReceiptHandle</name> <description> <para>The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the <code><a>ReceiveMessage</a></code> action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>VisibilityTimeout</name> <description> <para>The new value for the message's visibility timeout (in seconds). Values values: <code>0</code> to <code>43200</code>. Maximum: 12 hours. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs are case-sensitive. </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="2"> <name>ReceiptHandle</name> <description> <para>The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the <code><a>ReceiveMessage</a></code> action. </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="False" position="3"> <name>VisibilityTimeout</name> <description> <para>The new value for the message's visibility timeout (in seconds). Values values: <code>0</code> to <code>43200</code>. Maximum: 12 hours. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.ChangeMessageVisibilityResponse) 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=Edit-SQSMessageVisibility.html&tocid=Edit-SQSMessageVisibility</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Edit-SQSMessageVisibility -QueueUrl https://sqs.us-east-1.amazonaws.com/8039EXAMPLE/MyQueue -ReceiptHandle AQEBgGDh...J/Iqww== -VisibilityTimeout 36000</code><remarks><para>Description</para><para>-----------</para><para>This example changes the visibility timeout for the message with the specified receipt handle in the specified queue to 10 hours (10 hours * 60 minutes * 60 seconds = 36000 seconds).</para><para /><para /></remarks> </example> </examples> </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>Edit-SQSMessageVisibilityBatch</name> <description> <para>Invokes the ChangeMessageVisibilityBatch operation against Amazon Simple Queue Service.</para> </description> <verb>Edit</verb> <noun>SQSMessageVisibilityBatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Changes the visibility timeout of multiple messages. This is a batch version of <code><a>ChangeMessageVisibility</a>.</code> The result of the action on each message is reported individually in the response. You can send up to 10 <code><a>ChangeMessageVisibility</a></code> requests with each <code>ChangeMessageVisibilityBatch</code> action. <important><para> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>. </para></important> Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: <code>&amp;Attribute.1=this</code> <code>&amp;Attribute.2=that</code> </para> </description> <syntax> <syntaxItem> <name>Edit-SQSMessageVisibilityBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Entry</name> <description> <para>A list of receipt handles of the messages for which the visibility timeout must be changed. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Entry</name> <description> <para>A list of receipt handles of the messages for which the visibility timeout must be changed. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry[]</parameterValue> <type> <name>Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs are case-sensitive. </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.SQS.Model.ChangeMessageVisibilityBatchResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SQS.Model.ChangeMessageVisibilityBatchResponse 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=Edit-SQSMessageVisibilityBatch.html&tocid=Edit-SQSMessageVisibilityBatch</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>------ Input: ------ $changeVisibilityRequest1 = New-Object Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry $changeVisibilityRequest1.Id = "Request1" $changeVisibilityRequest1.ReceiptHandle = "AQEBd329...v6gl8Q==" $changeVisibilityRequest1.VisibilityTimeout = 36000 $changeVisibilityRequest2 = New-Object Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry $changeVisibilityRequest2.Id = "Request2" $changeVisibilityRequest2.ReceiptHandle = "AQEBgGDh...J/Iqww==" $changeVisibilityRequest2.VisibilityTimeout = 18000 Edit-SQSMessageVisibilityBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $changeVisibilityRequest1, $changeVisibilityRequest2 ------- Output: ------- Failed Successful ------ ---------- {} {Request2, Request1}</code><remarks><para>Description</para><para>-----------</para><para>This example changes the visibility timeout for 2 messages with the specified receipt handles in the specified queue. The first message's visibility timeout is changed to 10 hours (10 hours * 60 minutes * 60 seconds = 36000 seconds). The second message's visibility timeout is changed to 5 hours (5 hours * 60 minutes * 60 seconds = 18000 seconds).</para><para /><para /></remarks> </example> </examples> </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>Get-SQSDeadLetterSourceQueue</name> <description> <para>Invokes the ListDeadLetterSourceQueues operation against Amazon Simple Queue Service.</para> </description> <verb>Get</verb> <noun>SQSDeadLetterSourceQueue</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute configured with a dead-letter queue. For more information about using dead-letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-SQSDeadLetterSourceQueue</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of a dead-letter queue. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of a dead-letter queue. Queue URLs are case-sensitive. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SQS.Model.ListDeadLetterSourceQueuesResponse) 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-SQSDeadLetterSourceQueue.html&tocid=Get-SQSDeadLetterSourceQueue</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SQSDeadLetterSourceQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue</code><remarks><para>Description</para><para>-----------</para><para>This example lists the URLs of any queues that rely on the specified queue as their dead letter queue.</para><para /><para /></remarks> </example> </examples> </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>Get-SQSQueue</name> <description> <para>Invokes the ListQueues operation against Amazon Simple Queue Service.</para> </description> <verb>Get</verb> <noun>SQSQueue</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional <code>QueueNamePrefix</code> parameter, only queues with a name that begins with the specified value are returned. </para> </description> <syntax> <syntaxItem> <name>Get-SQSQueue</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>QueueNamePrefix</name> <description> <para>A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue names are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>QueueNamePrefix</name> <description> <para>A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue names are case-sensitive. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SQS.Model.ListQueuesResponse) 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-SQSQueue.html&tocid=Get-SQSQueue</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SQSQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/AnotherQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/DeadLetterQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue</code><remarks><para>Description</para><para>-----------</para><para>This example lists all queues.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> Get-SQSQueue -QueueNamePrefix My https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue</code><remarks><para>Description</para><para>-----------</para><para>This example lists any queues that start with the specified name.</para><para /><para /></remarks> </example> </examples> </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>Get-SQSQueueAttribute</name> <description> <para>Invokes the GetQueueAttributes operation against Amazon Simple Queue Service.</para> </description> <verb>Get</verb> <noun>SQSQueueAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets attributes for the specified queue. To determine whether a queue is <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: <code>&amp;Attribute.1=this</code> <code>&amp;Attribute.2=that</code> </para> </description> <syntax> <syntaxItem> <name>Get-SQSQueueAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AttributeName</name> <description> <para>A list of attributes for which to retrieve information. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. The following attributes are supported: - <code>All</code> - Returns all values. - <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html">Resources Required to Process Messages</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are waiting to be added to the queue. - <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have not timed-out and aren't deleted. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html">Resources Required to Process Messages</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). - <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. - <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). - <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it. - <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains a message. - <code>Policy</code> - Returns the policy of the queue. - <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. - <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the <code>ReceiveMessage</code> action waits for a message to arrive. - <code>RedrivePolicy</code> - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>deadLetterTargetArn</code> - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. - <code>maxReceiveCount</code> - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. - <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about the visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>: - <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. - <code>KmsDataKeyReusePeriodSeconds</code> - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>: - <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic">FIFO Queue Logic</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. To determine whether a queue is <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. - <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AttributeName</name> <description> <para>A list of attributes for which to retrieve information. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. The following attributes are supported: - <code>All</code> - Returns all values. - <code>ApproximateNumberOfMessages</code> - Returns the approximate number of visible messages in a queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html">Resources Required to Process Messages</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>ApproximateNumberOfMessagesDelayed</code> - Returns the approximate number of messages that are waiting to be added to the queue. - <code>ApproximateNumberOfMessagesNotVisible</code> - Returns the approximate number of messages that have not timed-out and aren't deleted. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html">Resources Required to Process Messages</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>CreatedTimestamp</code> - Returns the time when the queue was created in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). - <code>DelaySeconds</code> - Returns the default delay on the queue in seconds. - <code>LastModifiedTimestamp</code> - Returns the time when the queue was last changed in seconds (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a>). - <code>MaximumMessageSize</code> - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it. - <code>MessageRetentionPeriod</code> - Returns the length of time, in seconds, for which Amazon SQS retains a message. - <code>Policy</code> - Returns the policy of the queue. - <code>QueueArn</code> - Returns the Amazon resource name (ARN) of the queue. - <code>ReceiveMessageWaitTimeSeconds</code> - Returns the length of time, in seconds, for which the <code>ReceiveMessage</code> action waits for a message to arrive. - <code>RedrivePolicy</code> - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>deadLetterTargetArn</code> - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. - <code>maxReceiveCount</code> - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. - <code>VisibilityTimeout</code> - Returns the visibility timeout for the queue. For more information about the visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>: - <code>KmsMasterKeyId</code> - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. - <code>KmsDataKeyReusePeriodSeconds</code> - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>: - <code>FifoQueue</code> - Returns whether the queue is FIFO. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic">FIFO Queue Logic</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. To determine whether a queue is <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix. - <code>ContentBasedDeduplication</code> - Returns whether content-based deduplication is enabled for the queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs are case-sensitive. </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.SQS.Model.GetQueueAttributesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SQS.Model.GetQueueAttributesResponse 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-SQSQueueAttribute.html&tocid=Get-SQSQueueAttribute</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SQSQueueAttribute -AttributeName All -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue VisibilityTimeout : 30 DelaySeconds : 0 MaximumMessageSize : 262144 MessageRetentionPeriod : 345600 ApproximateNumberOfMessages : 0 ApproximateNumberOfMessagesNotVisible : 0 ApproximateNumberOfMessagesDelayed : 0 CreatedTimestamp : 2/11/2015 5:53:35 PM LastModifiedTimestamp : 12/29/2015 2:23:17 PM QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue Policy : {"Version":"2008-10-17","Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14 495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80 398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid": "SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":" arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]} Attributes : {[QueueArn, arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue], [ApproximateNumberOfMessages, 0], [ApproximateNumberOfMessagesNotVisible, 0], [ApproximateNumberOfMessagesDelayed, 0]...}</code><remarks><para>Description</para><para>-----------</para><para>This example lists all attributes for the specified queue.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> Get-SQSQueueAttribute -AttributeName MaximumMessageSize, VisibilityTimeout -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue VisibilityTimeout : 30 DelaySeconds : 0 MaximumMessageSize : 262144 MessageRetentionPeriod : 345600 ApproximateNumberOfMessages : 0 ApproximateNumberOfMessagesNotVisible : 0 ApproximateNumberOfMessagesDelayed : 0 CreatedTimestamp : 2/11/2015 5:53:35 PM LastModifiedTimestamp : 12/29/2015 2:23:17 PM QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue Policy : {"Version":"2008-10-17","Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14 495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80 398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid": "SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":" arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]} Attributes : {[MaximumMessageSize, 262144], [VisibilityTimeout, 30]}</code><remarks><para>Description</para><para>-----------</para><para>This example lists separately only the specified attributes for the specified queue.</para><para /><para /></remarks> </example> </examples> </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>Get-SQSQueueUrl</name> <description> <para>Invokes the GetQueueUrl operation against Amazon Simple Queue Service.</para> </description> <verb>Get</verb> <noun>SQSQueueUrl</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue. To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see <code><a>AddPermission</a></code> or see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-SQSQueueUrl</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueName</name> <description> <para>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>). Queue names are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>QueueOwnerAWSAccountId</name> <description> <para>The AWS account ID of the account that created the queue. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueName</name> <description> <para>The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>). Queue names are case-sensitive. </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="False" position="2"> <name>QueueOwnerAWSAccountId</name> <description> <para>The AWS account ID of the account that created the queue. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SQS.Model.GetQueueUrlResponse) 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-SQSQueueUrl.html&tocid=Get-SQSQueueUrl</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SQSQueueUrl -QueueName MyQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue</code><remarks><para>Description</para><para>-----------</para><para>This example lists the URL of the queue with the specified name.</para><para /><para /></remarks> </example> </examples> </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>Get-SQSResourceTag</name> <description> <para>Invokes the ListQueueTags operation against Amazon Simple Queue Service.</para> </description> <verb>Get</verb> <noun>SQSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-tagging-queues.html">Tagging Amazon SQS Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. When you use queue tags, keep the following guidelines in mind: - Adding more than 50 tags to a queue isn't recommended. - Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. - Tags are case-sensitive. - A new tag with a key identical to that of an existing tag overwrites the existing tag. - Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=technical">technical support request</a>. For a full list of tag restrictions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">Limits Related to Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-SQSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the queue. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the queue. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SQS.Model.ListQueueTagsResponse) 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-SQSResourceTag.html&tocid=Get-SQSResourceTag</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</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>New-SQSQueue</name> <description> <para>Invokes the CreateQueue operation against Amazon Simple Queue Service.</para> </description> <verb>New</verb> <noun>SQSQueue</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind: - If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue. You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving"> Moving From a Standard Queue to a FIFO Queue</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - If you don't provide a value for an attribute, the queue is created with the default value for the attribute. - If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. To successfully create a new queue, you must provide a queue name that adheres to the <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">limits related to queues</a> and is unique within the scope of your queues. To get the queue URL, use the <code><a>GetQueueUrl</a></code> action. <code><a>GetQueueUrl</a></code> requires only the <code>QueueName</code> parameter. be aware of existing queue names: - If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue. - If the queue name, attribute names, or attribute values don't match an existing queue, <code>CreateQueue</code> returns an error. Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: <code>&amp;Attribute.1=this</code> <code>&amp;Attribute.2=that</code> </para> </description> <syntax> <syntaxItem> <name>New-SQSQueue</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueName</name> <description> <para>The name of the new queue. The following limits apply to this name: - A queue name can have up to 80 characters. - Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>). - A FIFO queue name must end with the <code>.fifo</code> suffix. Queue names are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Attribute</name> <description> <para>A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the <code>CreateQueue</code> action uses: - <code>DelaySeconds</code> - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). The default is 0 (zero). - <code>MaximumMessageSize</code> - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). - <code>MessageRetentionPeriod</code> - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default is 345,600 (4 days). - <code>Policy</code> - The queue's policy. A valid AWS policy. For more information about policy structure, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. - <code>ReceiveMessageWaitTimeSeconds</code> - The length of time, in seconds, for which a <code><a>ReceiveMessage</a></code> action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). The default is 0 (zero). - <code>RedrivePolicy</code> - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>deadLetterTargetArn</code> - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. - <code>maxReceiveCount</code> - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. - <code>VisibilityTimeout</code> - The visibility timeout for the queue. Valid values: An integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>: - <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/<i>MyAlias</i></code>. For more examples, see <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. - <code>KmsDataKeyReusePeriodSeconds</code> - The length of time, in seconds, for which Amazon SQS can reuse a <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>: - <code>FifoQueue</code> - Designates a queue as FIFO. Valid values: <code>true</code>, <code>false</code>. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the <code>MessageGroupId</code> for your messages explicitly. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic">FIFO Queue Logic</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>ContentBasedDeduplication</code> - Enables content-based deduplication. Valid values: <code>true</code>, <code>false</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - Every message must have a unique <code>MessageDeduplicationId</code>, - You may provide a <code>MessageDeduplicationId</code> explicitly. - If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). - If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error. - If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. - When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. - If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters (such as the following) are ignored: - <code>ApproximateNumberOfMessages</code> - <code>ApproximateNumberOfMessagesDelayed</code> - <code>ApproximateNumberOfMessagesNotVisible</code> - <code>CreatedTimestamp</code> - <code>LastModifiedTimestamp</code> - <code>QueueArn</code> </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Attribute</name> <description> <para>A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the <code>CreateQueue</code> action uses: - <code>DelaySeconds</code> - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). The default is 0 (zero). - <code>MaximumMessageSize</code> - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). - <code>MessageRetentionPeriod</code> - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default is 345,600 (4 days). - <code>Policy</code> - The queue's policy. A valid AWS policy. For more information about policy structure, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. - <code>ReceiveMessageWaitTimeSeconds</code> - The length of time, in seconds, for which a <code><a>ReceiveMessage</a></code> action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). The default is 0 (zero). - <code>RedrivePolicy</code> - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>deadLetterTargetArn</code> - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. - <code>maxReceiveCount</code> - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. - <code>VisibilityTimeout</code> - The visibility timeout for the queue. Valid values: An integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>: - <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/<i>MyAlias</i></code>. For more examples, see <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. - <code>KmsDataKeyReusePeriodSeconds</code> - The length of time, in seconds, for which Amazon SQS can reuse a <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>: - <code>FifoQueue</code> - Designates a queue as FIFO. Valid values: <code>true</code>, <code>false</code>. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the <code>MessageGroupId</code> for your messages explicitly. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic">FIFO Queue Logic</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>ContentBasedDeduplication</code> - Enables content-based deduplication. Valid values: <code>true</code>, <code>false</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - Every message must have a unique <code>MessageDeduplicationId</code>, - You may provide a <code>MessageDeduplicationId</code> explicitly. - If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). - If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error. - If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. - When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. - If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters (such as the following) are ignored: - <code>ApproximateNumberOfMessages</code> - <code>ApproximateNumberOfMessagesDelayed</code> - <code>ApproximateNumberOfMessagesNotVisible</code> - <code>CreatedTimestamp</code> - <code>LastModifiedTimestamp</code> - <code>QueueArn</code> </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>QueueName</name> <description> <para>The name of the new queue. The following limits apply to this name: - A queue name can have up to 80 characters. - Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>). - A FIFO queue name must end with the <code>.fifo</code> suffix. Queue names are case-sensitive. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SQS.Model.CreateQueueResponse) 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=New-SQSQueue.html&tocid=New-SQSQueue</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> New-SQSQueue -QueueName MyQueue https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue</code><remarks><para>Description</para><para>-----------</para><para>This example creates a queue with the specified name.</para><para /><para /></remarks> </example> </examples> </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>Receive-SQSMessage</name> <description> <para>Invokes the ReceiveMessage operation against Amazon Simple Queue Service.</para> </description> <verb>Receive</verb> <noun>SQSMessage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves one or more messages (up to 10), from the specified queue. Using the <code>WaitTimeSeconds</code> parameter enables long-poll support. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Polling</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. Short poll is the default behavior where a weighted random set of machines is sampled on a <code>ReceiveMessage</code> call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per <code>ReceiveMessage</code> call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular <code>ReceiveMessage</code> response. If this happens, repeat the request. For each message returned, the response includes the following: - The message body. - An MD5 digest of the message body. For information about MD5, see <a href="https://www.ietf.org/rfc/rfc1321.txt">RFC1321</a>. - The <code>MessageId</code> you received when you sent the message to the queue. - The receipt handle. - The message attributes. - An MD5 digest of the message attributes. The receipt handle is the identifier you must provide when deleting the message. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html">Queue and Message Identifiers</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. You can provide the <code>VisibilityTimeout</code> parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. </para> </description> <syntax> <syntaxItem> <name>Receive-SQSMessage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue from which messages are received. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>MessageCount</name> <description> <para>The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values are 1 to 10. Default is 1. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>VisibilityTimeout</name> <description> <para>The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a <code>ReceiveMessage</code> request. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>AttributeName</name> <description> <para>A list of attributes that need to be returned along with each message. These attributes include: - <code>All</code> - Returns all values. - <code>ApproximateFirstReceiveTimestamp</code> - Returns the time the message was first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds). - <code>ApproximateReceiveCount</code> - Returns the number of times a message has been received from the queue but not deleted. - <code>SenderId</code> - For an IAM user, returns the IAM user ID, for example <code>ABCDEFGHI1JKLMNOPQ23R</code>. - For an IAM role, returns the IAM role ID, for example <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>. - <code>SentTimestamp</code> - Returns the time the message was sent to the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds). - <code>MessageDeduplicationId</code> - Returns the value provided by the sender that calls the <code><a>SendMessage</a></code> action. - <code>MessageGroupId</code> - Returns the value provided by the sender that calls the <code><a>SendMessage</a></code> action. Messages with the same <code>MessageGroupId</code> are returned in sequence. - <code>SequenceNumber</code> - Returns the value provided by Amazon SQS. Any other valid special request parameters (such as the following) are ignored: - <code>ApproximateNumberOfMessages</code> - <code>ApproximateNumberOfMessagesDelayed</code> - <code>ApproximateNumberOfMessagesNotVisible</code> - <code>CreatedTimestamp</code> - <code>ContentBasedDeduplication</code> - <code>DelaySeconds</code> - <code>FifoQueue</code> - <code>LastModifiedTimestamp</code> - <code>MaximumMessageSize</code> - <code>MessageRetentionPeriod</code> - <code>Policy</code> - <code>QueueArn</code>, - <code>ReceiveMessageWaitTimeSeconds</code> - <code>RedrivePolicy</code> - <code>VisibilityTimeout</code> </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>WaitTimeInSeconds</name> <description> <para>The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageAttributeName</name> <description> <para>The name of the message attribute, where <i>N</i> is the index. - The name can contain alphanumeric characters and the underscore (<code>_</code>), hyphen (<code>-</code>), and period (<code>.</code>). - The name is case-sensitive and must be unique among all attribute names for the message. - The name must not start with AWS-reserved prefixes such as <code>AWS.</code> or <code>Amazon.</code> (or any casing variants). - The name must not start or end with a period (<code>.</code>), and it should not have periods in succession (<code>..</code>). - The name can be up to 256 characters long. When using <code>ReceiveMessage</code>, you can send a list of attribute names to receive, or you can return all of the attributes by specifying <code>All</code> or <code>.*</code> in your request. You can also use all message attributes starting with a prefix, for example <code>bar.*</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReceiveRequestAttemptId</name> <description> <para>This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you receive a generic error, you can retry the same action with an identical <code>ReceiveRequestAttemptId</code> to retrieve the same set of messages, even if their visibility timeout has not yet expired. - You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a <code>ReceiveMessage</code> action. - When you set <code>FifoQueue</code>, a caller of the <code>ReceiveMessage</code> action can provide a <code>ReceiveRequestAttemptId</code> explicitly. - If a caller of the <code>ReceiveMessage</code> action doesn't provide a <code>ReceiveRequestAttemptId</code>, Amazon SQS generates a <code>ReceiveRequestAttemptId</code>. - You can retry the <code>ReceiveMessage</code> action with the same <code>ReceiveRequestAttemptId</code> if none of the messages have been modified (deleted or had their visibility changes). - During a visibility timeout, subsequent calls with the same <code>ReceiveRequestAttemptId</code> return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. <important><para>If a caller of the <code>ReceiveMessage</code> action is still processing messages when the visibility timeout expires and messages become visible, another worker reading from the same queue can receive the same messages and therefore process duplicates. Also, if a reader whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.</para><para>To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.</para></important> - While messages with a particular <code>MessageGroupId</code> are invisible, no more messages belonging to the same <code>MessageGroupId</code> are returned until the visibility timeout expires. You can still receive messages with another <code>MessageGroupId</code> as long as it is also visible. - If a caller of <code>ReceiveMessage</code> can't track the <code>ReceiveRequestAttemptId</code>, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order. The length of <code>ReceiveRequestAttemptId</code> is 128 characters. <code>ReceiveRequestAttemptId</code> can contain alphanumeric characters (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation (<code>!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~</code>). For best practices of using <code>ReceiveRequestAttemptId</code>, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-receiverequestattemptid-request-parameter">Using the ReceiveRequestAttemptId Request Parameter</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>AttributeName</name> <description> <para>A list of attributes that need to be returned along with each message. These attributes include: - <code>All</code> - Returns all values. - <code>ApproximateFirstReceiveTimestamp</code> - Returns the time the message was first received from the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds). - <code>ApproximateReceiveCount</code> - Returns the number of times a message has been received from the queue but not deleted. - <code>SenderId</code> - For an IAM user, returns the IAM user ID, for example <code>ABCDEFGHI1JKLMNOPQ23R</code>. - For an IAM role, returns the IAM role ID, for example <code>ABCDE1F2GH3I4JK5LMNOP:i-a123b456</code>. - <code>SentTimestamp</code> - Returns the time the message was sent to the queue (<a href="http://en.wikipedia.org/wiki/Unix_time">epoch time</a> in milliseconds). - <code>MessageDeduplicationId</code> - Returns the value provided by the sender that calls the <code><a>SendMessage</a></code> action. - <code>MessageGroupId</code> - Returns the value provided by the sender that calls the <code><a>SendMessage</a></code> action. Messages with the same <code>MessageGroupId</code> are returned in sequence. - <code>SequenceNumber</code> - Returns the value provided by Amazon SQS. Any other valid special request parameters (such as the following) are ignored: - <code>ApproximateNumberOfMessages</code> - <code>ApproximateNumberOfMessagesDelayed</code> - <code>ApproximateNumberOfMessagesNotVisible</code> - <code>CreatedTimestamp</code> - <code>ContentBasedDeduplication</code> - <code>DelaySeconds</code> - <code>FifoQueue</code> - <code>LastModifiedTimestamp</code> - <code>MaximumMessageSize</code> - <code>MessageRetentionPeriod</code> - <code>Policy</code> - <code>QueueArn</code>, - <code>ReceiveMessageWaitTimeSeconds</code> - <code>RedrivePolicy</code> - <code>VisibilityTimeout</code> </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="False" 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="False" position="Named"> <name>MessageAttributeName</name> <description> <para>The name of the message attribute, where <i>N</i> is the index. - The name can contain alphanumeric characters and the underscore (<code>_</code>), hyphen (<code>-</code>), and period (<code>.</code>). - The name is case-sensitive and must be unique among all attribute names for the message. - The name must not start with AWS-reserved prefixes such as <code>AWS.</code> or <code>Amazon.</code> (or any casing variants). - The name must not start or end with a period (<code>.</code>), and it should not have periods in succession (<code>..</code>). - The name can be up to 256 characters long. When using <code>ReceiveMessage</code>, you can send a list of attribute names to receive, or you can return all of the attributes by specifying <code>All</code> or <code>.*</code> in your request. You can also use all message attributes starting with a prefix, for example <code>bar.*</code>. </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="False" position="2"> <name>MessageCount</name> <description> <para>The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values are 1 to 10. Default is 1. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue from which messages are received. Queue URLs are case-sensitive. </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="False" position="Named"> <name>ReceiveRequestAttemptId</name> <description> <para>This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of <code>ReceiveMessage</code> calls. If a networking issue occurs after a <code>ReceiveMessage</code> action, and instead of a response you receive a generic error, you can retry the same action with an identical <code>ReceiveRequestAttemptId</code> to retrieve the same set of messages, even if their visibility timeout has not yet expired. - You can use <code>ReceiveRequestAttemptId</code> only for 5 minutes after a <code>ReceiveMessage</code> action. - When you set <code>FifoQueue</code>, a caller of the <code>ReceiveMessage</code> action can provide a <code>ReceiveRequestAttemptId</code> explicitly. - If a caller of the <code>ReceiveMessage</code> action doesn't provide a <code>ReceiveRequestAttemptId</code>, Amazon SQS generates a <code>ReceiveRequestAttemptId</code>. - You can retry the <code>ReceiveMessage</code> action with the same <code>ReceiveRequestAttemptId</code> if none of the messages have been modified (deleted or had their visibility changes). - During a visibility timeout, subsequent calls with the same <code>ReceiveRequestAttemptId</code> return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. <important><para>If a caller of the <code>ReceiveMessage</code> action is still processing messages when the visibility timeout expires and messages become visible, another worker reading from the same queue can receive the same messages and therefore process duplicates. Also, if a reader whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.</para><para>To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.</para></important> - While messages with a particular <code>MessageGroupId</code> are invisible, no more messages belonging to the same <code>MessageGroupId</code> are returned until the visibility timeout expires. You can still receive messages with another <code>MessageGroupId</code> as long as it is also visible. - If a caller of <code>ReceiveMessage</code> can't track the <code>ReceiveRequestAttemptId</code>, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order. The length of <code>ReceiveRequestAttemptId</code> is 128 characters. <code>ReceiveRequestAttemptId</code> can contain alphanumeric characters (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation (<code>!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~</code>). For best practices of using <code>ReceiveRequestAttemptId</code>, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-receiverequestattemptid-request-parameter">Using the ReceiveRequestAttemptId Request Parameter</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </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="False" position="3"> <name>VisibilityTimeout</name> <description> <para>The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a <code>ReceiveMessage</code> request. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>WaitTimeInSeconds</name> <description> <para>The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SQS.Model.Message</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Message objects. The service call response (type Amazon.SQS.Model.ReceiveMessageResponse) 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=Receive-SQSMessage.html&tocid=Receive-SQSMessage</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Receive-SQSMessage -AttributeName SenderId, SentTimestamp -MessageAttributeName StudentName, StudentGrade -MessageCount 10 -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue Attributes : {[SenderId, AIDAIAZKMSNQ7TEXAMPLE], [SentTimestamp, 1451495923744]} Body : Information about John Doe's grade. MD5OfBody : ea572796e3c231f974fe75d89EXAMPLE MD5OfMessageAttributes : 48c1ee811f0fe7c4e88fbe0f5EXAMPLE MessageAttributes : {[StudentGrade, Amazon.SQS.Model.MessageAttributeValue], [StudentName, Amazon.SQS.Model.MessageAttributeValue]} MessageId : 53828c4b-631b-469b-8833-c093cEXAMPLE ReceiptHandle : AQEBpfGp...20Q5cg==</code><remarks><para>Description</para><para>-----------</para><para>This example lists information for up to the next 10 messages to be received for the specified queue. The information will contain values for the specified message attributes, if they exist.</para><para /><para /></remarks> </example> </examples> </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-SQSMessage</name> <description> <para>Invokes the DeleteMessage operation against Amazon Simple Queue Service.</para> </description> <verb>Remove</verb> <noun>SQSMessage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified message from the specified queue. You specify the message by using the message's <i>receipt handle</i> and not the <i>MessageId</i> you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message. The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the <code>DeleteMessage</code> action, the request succeeds, but the message might not be deleted. For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues. </para> </description> <syntax> <syntaxItem> <name>Remove-SQSMessage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>ReceiptHandle</name> <description> <para>The receipt handle associated with the message to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive. </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="2"> <name>ReceiptHandle</name> <description> <para>The receipt handle associated with the message to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.DeleteMessageResponse) 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-SQSMessage.html&tocid=Remove-SQSMessage</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-SQSMessage -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -ReceiptHandle AQEBd329...v6gl8Q==</code><remarks><para>Description</para><para>-----------</para><para>This example deletes the message with the specified receipt handle from the specified queue.</para><para /><para /></remarks> </example> </examples> </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-SQSMessageBatch</name> <description> <para>Invokes the DeleteMessageBatch operation against Amazon Simple Queue Service.</para> </description> <verb>Remove</verb> <noun>SQSMessageBatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes up to ten messages from the specified queue. This is a batch version of <code><a>DeleteMessage</a>.</code> The result of the action on each message is reported individually in the response. <important><para> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>. </para></important> Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: <code>&amp;Attribute.1=this</code> <code>&amp;Attribute.2=that</code> </para> </description> <syntax> <syntaxItem> <name>Remove-SQSMessageBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Entry</name> <description> <para>A list of receipt handles for the messages to be deleted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SQS.Model.DeleteMessageBatchRequestEntry[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Entry</name> <description> <para>A list of receipt handles for the messages to be deleted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SQS.Model.DeleteMessageBatchRequestEntry[]</parameterValue> <type> <name>Amazon.SQS.Model.DeleteMessageBatchRequestEntry[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive. </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.SQS.Model.DeleteMessageBatchResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SQS.Model.DeleteMessageBatchResponse 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=Remove-SQSMessageBatch.html&tocid=Remove-SQSMessageBatch</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>------ Input: ------ $deleteMessageRequest1 = New-Object Amazon.SQS.Model.DeleteMessageBatchRequestEntry $deleteMessageRequest1.Id = "Request1" $deleteMessageRequest1.ReceiptHandle = "AQEBX2g4...wtJSQg==" $deleteMessageRequest2 = New-Object Amazon.SQS.Model.DeleteMessageBatchRequestEntry $deleteMessageRequest2.Id = "Request2" $deleteMessageRequest2.ReceiptHandle = "AQEBqOVY...KTsLYg==" Remove-SQSMessageBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $deleteMessageRequest1, $deleteMessageRequest2 ------- Output: ------- Failed Successful ------ ---------- {} {Request1, Request2}</code><remarks><para>Description</para><para>-----------</para><para>This example deletes 2 messages with the specified receipt handles from the specified queue.</para><para /><para /></remarks> </example> </examples> </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-SQSPermission</name> <description> <para>Invokes the RemovePermission operation against Amazon Simple Queue Service.</para> </description> <verb>Remove</verb> <noun>SQSPermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter. Only the owner of the queue can remove permissions. </para> </description> <syntax> <syntaxItem> <name>Remove-SQSPermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue from which permissions are removed. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Label</name> <description> <para>The identification of the permission to remove. This is the label added using the <code><a>AddPermission</a></code> action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>Label</name> <description> <para>The identification of the permission to remove. This is the label added using the <code><a>AddPermission</a></code> action. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue from which permissions are removed. Queue URLs are case-sensitive. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.RemovePermissionResponse) 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-SQSPermission.html&tocid=Remove-SQSPermission</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-SQSPermission -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue</code><remarks><para>Description</para><para>-----------</para><para>This example removes the permission settings with the specified label from the specified queue.</para><para /><para /></remarks> </example> </examples> </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-SQSQueue</name> <description> <para>Invokes the DeleteQueue operation against Amazon Simple Queue Service.</para> </description> <verb>Remove</verb> <noun>SQSQueue</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's contents. If the specified queue doesn't exist, Amazon SQS returns a successful response. <important><para> Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any messages in the queue are no longer available. </para></important> When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a <code><a>SendMessage</a></code> request might succeed, but after 60 seconds the queue and the message you sent no longer exist. When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> </description> <syntax> <syntaxItem> <name>Remove-SQSQueue</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue to delete. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue to delete. Queue URLs are case-sensitive. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.DeleteQueueResponse) 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-SQSQueue.html&tocid=Remove-SQSQueue</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue</code><remarks><para>Description</para><para>-----------</para><para>This example deletes the specified queue.</para><para /><para /></remarks> </example> </examples> </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-SQSResourceTag</name> <description> <para>Invokes the UntagQueue operation against Amazon Simple Queue Service.</para> </description> <verb>Remove</verb> <noun>SQSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-tagging-queues.html">Tagging Amazon SQS Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. When you use queue tags, keep the following guidelines in mind: - Adding more than 50 tags to a queue isn't recommended. - Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. - Tags are case-sensitive. - A new tag with a key identical to that of an existing tag overwrites the existing tag. - Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=technical">technical support request</a>. For a full list of tag restrictions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">Limits Related to Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Remove-SQSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the queue. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>The list of tags to be removed from the specified queue. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the queue. </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="False" position="Named"> <name>TagKey</name> <description> <para>The list of tags to be removed from the specified queue. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.UntagQueueResponse) 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-SQSResourceTag.html&tocid=Remove-SQSResourceTag</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</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-SQSMessage</name> <description> <para>Invokes the SendMessage operation against Amazon Simple Queue Service.</para> </description> <verb>Send</verb> <noun>SQSMessage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delivers a message to the specified queue. <important><para> A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: </para><para><code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code></para><para> Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>. </para></important> </para> </description> <syntax> <syntaxItem> <name>Send-SQSMessage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue to which a message is sent. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>MessageBody</name> <description> <para>The message to send. The maximum string size is 256 KB. <important><para>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</para><para><code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code></para><para>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</para></important> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DelayInSeconds</name> <description> <para> The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies. When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per message. You can set this parameter only on a queue level. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageAttribute</name> <description> <para>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and <code>Value</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation">Message Attribute Items and Validation</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageDeduplicationId</name> <description> <para>This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing"> Exactly-Once Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - Every message must have a unique <code>MessageDeduplicationId</code>, - You may provide a <code>MessageDeduplicationId</code> explicitly. - If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). - If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error. - If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. - When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. - If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered. The <code>MessageDeduplicationId</code> is available to the recipient of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same <code>MessageDeduplicationId</code> after the deduplication interval, Amazon SQS can't detect duplicate messages. The length of <code>MessageDeduplicationId</code> is 128 characters. <code>MessageDeduplicationId</code> can contain alphanumeric characters (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation (<code>!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~</code>). For best practices of using <code>MessageDeduplicationId</code>, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagededuplicationid-property">Using the MessageDeduplicationId Property</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageGroupId</name> <description> <para>This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use <code>MessageGroupId</code> values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion. - You must associate a non-empty <code>MessageGroupId</code> with a message. If you don't provide a <code>MessageGroupId</code>, the action fails. - <code>ReceiveMessage</code> might return messages with multiple <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>, the messages are sorted by time sent. The caller can't specify a <code>MessageGroupId</code>. The length of <code>MessageGroupId</code> is 128 characters. Valid values are alphanumeric characters and punctuation <code>(!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~)</code>. For best practices of using <code>MessageGroupId</code>, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property">Using the MessageGroupId Property</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. <important><para><code>MessageGroupId</code> is required for FIFO queues. You can't use it for Standard queues.</para></important> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DelayInSeconds</name> <description> <para> The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive <code>DelaySeconds</code> value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies. When you set <code>FifoQueue</code>, you can't set <code>DelaySeconds</code> per message. You can set this parameter only on a queue level. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>MessageAttribute</name> <description> <para>Each message attribute consists of a <code>Name</code>, <code>Type</code>, and <code>Value</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation">Message Attribute Items and Validation</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>MessageBody</name> <description> <para>The message to send. The maximum string size is 256 KB. <important><para>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</para><para><code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code></para><para>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</para></important> </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="False" position="Named"> <name>MessageDeduplicationId</name> <description> <para>This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, any messages sent with the same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing"> Exactly-Once Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - Every message must have a unique <code>MessageDeduplicationId</code>, - You may provide a <code>MessageDeduplicationId</code> explicitly. - If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). - If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error. - If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. - When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. - If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered. The <code>MessageDeduplicationId</code> is available to the recipient of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same <code>MessageDeduplicationId</code> after the deduplication interval, Amazon SQS can't detect duplicate messages. The length of <code>MessageDeduplicationId</code> is 128 characters. <code>MessageDeduplicationId</code> can contain alphanumeric characters (<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>) and punctuation (<code>!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~</code>). For best practices of using <code>MessageDeduplicationId</code>, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagededuplicationid-property">Using the MessageDeduplicationId Property</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. </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="False" position="Named"> <name>MessageGroupId</name> <description> <para>This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use <code>MessageGroupId</code> values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion. - You must associate a non-empty <code>MessageGroupId</code> with a message. If you don't provide a <code>MessageGroupId</code>, the action fails. - <code>ReceiveMessage</code> might return messages with multiple <code>MessageGroupId</code> values. For each <code>MessageGroupId</code>, the messages are sorted by time sent. The caller can't specify a <code>MessageGroupId</code>. The length of <code>MessageGroupId</code> is 128 characters. Valid values are alphanumeric characters and punctuation <code>(!"#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~)</code>. For best practices of using <code>MessageGroupId</code>, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property">Using the MessageGroupId Property</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. <important><para><code>MessageGroupId</code> is required for FIFO queues. You can't use it for Standard queues.</para></important> </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue to which a message is sent. Queue URLs are case-sensitive. </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.SQS.Model.SendMessageResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SQS.Model.SendMessageResponse 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=Send-SQSMessage.html&tocid=Send-SQSMessage</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>------ Input: ------ $cityAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $cityAttributeValue.DataType = "String" $cityAttributeValue.StringValue = "AnyCity" $populationAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $populationAttributeValue.DataType = "Number" $populationAttributeValue.StringValue = "1250800" $messageAttributes = New-Object System.Collections.Hashtable $messageAttributes.Add("City", $cityAttributeValue) $messageAttributes.Add("Population", $populationAttributeValue) Send-SQSMessage -DelayInSeconds 10 -MessageAttributes $messageAttributes -MessageBody "Information about the largest city in Any Region." -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue ------- Output: ------- MD5OfMessageAttributes MD5OfMessageBody MessageId ---------------------- ---------------- --------- 1d3e51347bc042efbdf6dda31EXAMPLE 51b0a3256d59467f973009b73EXAMPLE c35fed8f-c739-4d0c-818b-1820eEXAMPLE</code><remarks><para>Description</para><para>-----------</para><para>This example sends a message with the specified attributes and message body to the specified queue with message delivery delayed for 10 seconds.</para><para /><para /></remarks> </example> </examples> </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-SQSMessageBatch</name> <description> <para>Invokes the SendMessageBatch operation against Amazon Simple Queue Service.</para> </description> <verb>Send</verb> <noun>SQSMessageBatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delivers up to ten messages to the specified queue. This is a batch version of <code><a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent. The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>. The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). <important><para> A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: </para><para><code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code></para><para> Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>. </para></important> If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses the default value for the queue. Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: <code>&amp;Attribute.1=this</code> <code>&amp;Attribute.2=that</code> </para> </description> <syntax> <syntaxItem> <name>Send-SQSMessageBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Entry</name> <description> <para>A list of <code><a>SendMessageBatchRequestEntry</a></code> items. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SQS.Model.SendMessageBatchRequestEntry[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Entry</name> <description> <para>A list of <code><a>SendMessageBatchRequestEntry</a></code> items. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SQS.Model.SendMessageBatchRequestEntry[]</parameterValue> <type> <name>Amazon.SQS.Model.SendMessageBatchRequestEntry[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs are case-sensitive. </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.SQS.Model.SendMessageBatchResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SQS.Model.SendMessageBatchResponse 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=Send-SQSMessageBatch.html&tocid=Send-SQSMessageBatch</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>------ Input: ------ $student1NameAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $student1NameAttributeValue.DataType = "String" $student1NameAttributeValue.StringValue = "John Doe" $student1GradeAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $student1GradeAttributeValue.DataType = "Number" $student1GradeAttributeValue.StringValue = "89" $student2NameAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $student2NameAttributeValue.DataType = "String" $student2NameAttributeValue.StringValue = "Jane Doe" $student2GradeAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue $student2GradeAttributeValue.DataType = "Number" $student2GradeAttributeValue.StringValue = "93" $message1 = New-Object Amazon.SQS.Model.SendMessageBatchRequestEntry $message1.DelaySeconds = 15 $message1.Id = "FirstMessage" $message1.MessageAttributes.Add("StudentName", $student1NameAttributeValue) $message1.MessageAttributes.Add("StudentGrade", $student1GradeAttributeValue) $message1.MessageBody = "Information about John Doe's grade." $message2 = New-Object Amazon.SQS.Model.SendMessageBatchRequestEntry $message2.DelaySeconds = 10 $message2.Id = "SecondMessage" $message2.MessageAttributes.Add("StudentName", $student2NameAttributeValue) $message2.MessageAttributes.Add("StudentGrade", $student2GradeAttributeValue) $message2.MessageBody = "Information about Jane Doe's grade." Send-SQSMessageBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $message1, $message2 ------- Output: ------- Failed Successful ------ ---------- {} {FirstMessage, SecondMessage}</code><remarks><para>Description</para><para>-----------</para><para>This example sends 2 messages with the specified attributes and message bodies to the specified queue. Delivery is delayed for 15 seconds for the first message and 10 seconds for the second message.</para><para /><para /></remarks> </example> </examples> </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>Set-SQSQueueAttribute</name> <description> <para>Invokes the SetQueueAttributes operation against Amazon Simple Queue Service.</para> </description> <verb>Set</verb> <noun>SQSQueueAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes. In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. </para> </description> <syntax> <syntaxItem> <name>Set-SQSQueueAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue whose attributes are set. Queue URLs are case-sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Attribute</name> <description> <para>A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the <code>SetQueueAttributes</code> action uses: - <code>DelaySeconds</code> - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). The default is 0 (zero). - <code>MaximumMessageSize</code> - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). - <code>MessageRetentionPeriod</code> - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is 345,600 (4 days). - <code>Policy</code> - The queue's policy. A valid AWS policy. For more information about policy structure, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. - <code>ReceiveMessageWaitTimeSeconds</code> - The length of time, in seconds, for which a <code><a>ReceiveMessage</a></code> action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0. - <code>RedrivePolicy</code> - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>deadLetterTargetArn</code> - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. - <code>maxReceiveCount</code> - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. - <code>VisibilityTimeout</code> - The visibility timeout for the queue. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>: - <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/<i>MyAlias</i></code>. For more examples, see <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. - <code>KmsDataKeyReusePeriodSeconds</code> - The length of time, in seconds, for which Amazon SQS can reuse a <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>. The following attribute applies only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>: - <code>ContentBasedDeduplication</code> - Enables content-based deduplication. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - Every message must have a unique <code>MessageDeduplicationId</code>, - You may provide a <code>MessageDeduplicationId</code> explicitly. - If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). - If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error. - If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. - When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. - If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters (such as the following) are ignored: - <code>ApproximateNumberOfMessages</code> - <code>ApproximateNumberOfMessagesDelayed</code> - <code>ApproximateNumberOfMessagesNotVisible</code> - <code>CreatedTimestamp</code> - <code>LastModifiedTimestamp</code> - <code>QueueArn</code> </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Attribute</name> <description> <para>A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters that the <code>SetQueueAttributes</code> action uses: - <code>DelaySeconds</code> - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). The default is 0 (zero). - <code>MaximumMessageSize</code> - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB). - <code>MessageRetentionPeriod</code> - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is 345,600 (4 days). - <code>Policy</code> - The queue's policy. A valid AWS policy. For more information about policy structure, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>. - <code>ReceiveMessageWaitTimeSeconds</code> - The length of time, in seconds, for which a <code><a>ReceiveMessage</a></code> action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0. - <code>RedrivePolicy</code> - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - <code>deadLetterTargetArn</code> - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. - <code>maxReceiveCount</code> - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. - <code>VisibilityTimeout</code> - The visibility timeout for the queue. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. The following attributes apply only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html">server-side-encryption</a>: - <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms">Key Terms</a>. While the alias of the AWS-managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/<i>MyAlias</i></code>. For more examples, see <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. - <code>KmsDataKeyReusePeriodSeconds</code> - The length of time, in seconds, for which Amazon SQS can reuse a <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data key</a> to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work">How Does the Data Key Reuse Period Work?</a>. The following attribute applies only to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO (first-in-first-out) queues</a>: - <code>ContentBasedDeduplication</code> - Enables content-based deduplication. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing">Exactly-Once Processing</a> in the <i>Amazon Simple Queue Service Developer Guide</i>. - Every message must have a unique <code>MessageDeduplicationId</code>, - You may provide a <code>MessageDeduplicationId</code> explicitly. - If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). - If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error. - If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. - When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. - If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered. Any other valid special request parameters (such as the following) are ignored: - <code>ApproximateNumberOfMessages</code> - <code>ApproximateNumberOfMessagesDelayed</code> - <code>ApproximateNumberOfMessagesNotVisible</code> - <code>CreatedTimestamp</code> - <code>LastModifiedTimestamp</code> - <code>QueueArn</code> </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>QueueUrl</name> <description> <para>The URL of the Amazon SQS queue whose attributes are set. Queue URLs are case-sensitive. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QueueUrl parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SQS.Model.SetQueueAttributesResponse) 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=Set-SQSQueueAttribute.html&tocid=Set-SQSQueueAttribute</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> # create the queue and topic to be associated PS C:\>$qurl = New-SQSQueue -QueueName "myQueue" PS C:\>$topicarn = New-SNSTopic -Name "myTopic" # get the queue ARN to inject into the policy; it will be returned # in the output's QueueARN member but we need to put it into a variable # so text expansion in the policy string takes effect PS C:\>$qarn = (Get-SQSQueueAttribute -QueueUrl $qurl -AttributeName "QueueArn").QueueARN # construct the policy and inject arns PS C:\>$policy = @" { "Version": "2008-10-17", "Id": "$qarn/SQSPOLICY", "Statement": [ { "Sid": "1", "Effect": "Allow", "Principal": "*", "Action": "SQS:SendMessage", "Resource": "$qarn", "Condition": { "ArnEquals": { "aws:SourceArn": "$topicarn" } } } ] } "@ # set the policy PS C:\>Set-SQSQueueAttribute -QueueUrl $qurl -Attribute @{ Policy=$policy } </code><remarks><para>Description</para><para>-----------</para><para>This example shows how to set a policy subscribing a queue to an SNS topic. When a message is published to the topic, a message is sent to the subscribed queue.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Set-SQSQueueAttribute -Attribute @{"DelaySeconds" = "10"; "MaximumMessageSize" = "131072"} -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue</code><remarks><para>Description</para><para>-----------</para><para>This example sets the specified attributes for the specified queue.</para><para /><para /></remarks> </example> </examples> </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>Get-SNOWAddress</name> <description> <para>Invokes the DescribeAddress operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWAddress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Takes an <code>AddressId</code> and returns specific details about that address in the form of an <code>Address</code> object. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWAddress</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AddressId</name> <description> <para>The automatically generated ID for a specific address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AddressId</name> <description> <para>The automatically generated ID for a specific address. </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.Snowball.Model.Address</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Address object. The service call response (type Amazon.Snowball.Model.DescribeAddressResponse) 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-SNOWAddress.html&tocid=Get-SNOWAddress</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWAddressList</name> <description> <para>Invokes the DescribeAddresses operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWAddressList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a specified number of <code>ADDRESS</code> objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWAddressList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The number of <code>ADDRESS</code> objects to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ADDRESS</code> objects, you have the option of specifying a value for <code>NextToken</code> as the starting point for your list of returned addresses. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The number of <code>ADDRESS</code> objects to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ADDRESS</code> objects, you have the option of specifying a value for <code>NextToken</code> as the starting point for your list of returned addresses. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Snowball.Model.Address</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Address objects. The service call response (type Amazon.Snowball.Model.DescribeAddressesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNOWAddressList.html&tocid=Get-SNOWAddressList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWCluster</name> <description> <para>Invokes the DescribeCluster operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about a specific cluster including shipping information, cluster status, and other important metadata. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ClusterId</name> <description> <para>The automatically generated ID for a cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ClusterId</name> <description> <para>The automatically generated ID for a cluster. </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.Snowball.Model.ClusterMetadata</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ClusterMetadata object. The service call response (type Amazon.Snowball.Model.DescribeClusterResponse) 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-SNOWCluster.html&tocid=Get-SNOWCluster</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWClusterJobList</name> <description> <para>Invokes the ListClusterJobs operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWClusterJobList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <code>JobListEntry</code> objects of the specified length. Each <code>JobListEntry</code> object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWClusterJobList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ClusterId</name> <description> <para>The 39-character ID for the cluster that you want to list, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The number of <code>JobListEntry</code> objects to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>JobListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ClusterId</name> <description> <para>The 39-character ID for the cluster that you want to list, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>. </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="False" position="Named"> <name>MaxResult</name> <description> <para>The number of <code>JobListEntry</code> objects to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>JobListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Snowball.Model.JobListEntry</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of JobListEntry objects. The service call response (type Amazon.Snowball.Model.ListClusterJobsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNOWClusterJobList.html&tocid=Get-SNOWClusterJobList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWClusterList</name> <description> <para>Invokes the ListClusters operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWClusterList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <code>ClusterListEntry</code> objects of the specified length. Each <code>ClusterListEntry</code> object contains a cluster's state, a cluster's ID, and other important status information.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWClusterList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The number of <code>ClusterListEntry</code> objects to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ClusterListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The number of <code>ClusterListEntry</code> objects to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ClusterListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Snowball.Model.ClusterListEntry</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ClusterListEntry objects. The service call response (type Amazon.Snowball.Model.ListClustersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNOWClusterList.html&tocid=Get-SNOWClusterList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWJob</name> <description> <para>Invokes the DescribeJob operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about a specific job including shipping information, job status, and other important metadata. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The automatically generated ID for a job, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The automatically generated ID for a job, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </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.Snowball.Model.DescribeJobResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Snowball.Model.DescribeJobResponse 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-SNOWJob.html&tocid=Get-SNOWJob</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWJobManifest</name> <description> <para>Invokes the GetJobManifest operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWJobManifest</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified <code>JobId</code> value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the <code>GetJobManifest</code> action. The manifest is an encrypted file that you can download after your job enters the <code>WithCustomer</code> status. The manifest is decrypted by using the <code>UnlockCode</code> code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an <code>UnlockCode</code> value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWJobManifest</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The ID for a job that you want to get the manifest file for, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The ID for a job that you want to get the manifest file for, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Snowball.Model.GetJobManifestResponse) 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-SNOWJobManifest.html&tocid=Get-SNOWJobManifest</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWJobsList</name> <description> <para>Invokes the ListJobs operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWJobsList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <code>JobListEntry</code> objects of the specified length. Each <code>JobListEntry</code> object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWJobsList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The number of <code>JobListEntry</code> objects to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>JobListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The number of <code>JobListEntry</code> objects to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>JobListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Snowball.Model.JobListEntry</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of JobListEntry objects. The service call response (type Amazon.Snowball.Model.ListJobsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNOWJobsList.html&tocid=Get-SNOWJobsList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWJobUnlockCode</name> <description> <para>Invokes the GetJobUnlockCode operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWJobUnlockCode</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the <code>UnlockCode</code> code value for the specified job. A particular <code>UnlockCode</code> value can be accessed for up to 90 days after the associated job has been created. The <code>UnlockCode</code> value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of the <code>UnlockCode</code> in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWJobUnlockCode</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The ID for the job that you want to get the <code>UnlockCode</code> value for, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The ID for the job that you want to get the <code>UnlockCode</code> value for, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Snowball.Model.GetJobUnlockCodeResponse) 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-SNOWJobUnlockCode.html&tocid=Get-SNOWJobUnlockCode</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SNOWSnowballUsage</name> <description> <para>Invokes the GetSnowballUsage operation against AWS Import/Export Snowball.</para> </description> <verb>Get</verb> <noun>SNOWSnowballUsage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use. The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support. </para> </description> <syntax> <syntaxItem> <name>Get-SNOWSnowballUsage</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.Snowball.Model.GetSnowballUsageResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Snowball.Model.GetSnowballUsageResponse 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-SNOWSnowballUsage.html&tocid=Get-SNOWSnowballUsage</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>New-SNOWAddress</name> <description> <para>Invokes the CreateAddress operation against AWS Import/Export Snowball.</para> </description> <verb>New</verb> <noun>SNOWAddress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. </para> </description> <syntax> <syntaxItem> <name>New-SNOWAddress</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_AddressId</name> <description> <para>The unique ID for an address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_City</name> <description> <para>The city in an address that a Snowball is to be delivered to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_Company</name> <description> <para>The name of the company to receive a Snowball at an address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_Country</name> <description> <para>The country in an address that a Snowball is to be delivered to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_IsRestricted</name> <description> <para>If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_Landmark</name> <description> <para>This field is no longer used and the value is ignored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_Name</name> <description> <para>The name of a person to receive a Snowball at an address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_PhoneNumber</name> <description> <para>The phone number associated with an address that a Snowball is to be delivered to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_PostalCode</name> <description> <para>The postal code in an address that a Snowball is to be delivered to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_PrefectureOrDistrict</name> <description> <para>This field is no longer used and the value is ignored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_StateOrProvince</name> <description> <para>The state or province in an address that a Snowball is to be delivered to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_Street1</name> <description> <para>The first line in a street address that a Snowball is to be delivered to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_Street2</name> <description> <para>The second line in a street address that a Snowball is to be delivered to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_Street3</name> <description> <para>The third line in a street address that a Snowball is to be delivered to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_AddressId</name> <description> <para>The unique ID for an address. </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="False" position="Named"> <name>Address_City</name> <description> <para>The city in an address that a Snowball is to be delivered to. </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="False" position="Named"> <name>Address_Company</name> <description> <para>The name of the company to receive a Snowball at an address. </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="False" position="Named"> <name>Address_Country</name> <description> <para>The country in an address that a Snowball is to be delivered to. </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="False" position="Named"> <name>Address_IsRestricted</name> <description> <para>If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Address_Landmark</name> <description> <para>This field is no longer used and the value is ignored. </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="False" position="Named"> <name>Address_Name</name> <description> <para>The name of a person to receive a Snowball at an address. </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="False" position="Named"> <name>Address_PhoneNumber</name> <description> <para>The phone number associated with an address that a Snowball is to be delivered to. </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="False" position="Named"> <name>Address_PostalCode</name> <description> <para>The postal code in an address that a Snowball is to be delivered to. </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="False" position="Named"> <name>Address_PrefectureOrDistrict</name> <description> <para>This field is no longer used and the value is ignored. </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="False" position="Named"> <name>Address_StateOrProvince</name> <description> <para>The state or province in an address that a Snowball is to be delivered to. </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="False" position="Named"> <name>Address_Street1</name> <description> <para>The first line in a street address that a Snowball is to be delivered to. </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="False" position="Named"> <name>Address_Street2</name> <description> <para>The second line in a street address that a Snowball is to be delivered to. </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="False" position="Named"> <name>Address_Street3</name> <description> <para>The third line in a street address that a Snowball is to be delivered to. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Snowball.Model.CreateAddressResponse) 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=New-SNOWAddress.html&tocid=New-SNOWAddress</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>New-SNOWCluster</name> <description> <para>Invokes the CreateCluster operation against AWS Import/Export Snowball.</para> </description> <verb>New</verb> <noun>SNOWCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an empty cluster. Each cluster supports five nodes. You use the <a>CreateJob</a> action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created. </para> </description> <syntax> <syntaxItem> <name>New-SNOWCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AddressId</name> <description> <para>The ID for the address that you want the cluster shipped to.> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ForwardingAddressId</name> <description> <para>The forwarding address ID for a cluster. This field is not supported in most regions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_JobStatesToNotify</name> <description> <para>The list of job states that will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>JobType</name> <description> <para>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.JobType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyARN</name> <description> <para>The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in AWS Key Management Service (AWS KMS). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_LambdaResource</name> <description> <para>The Python-language Lambda functions for this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.LambdaResource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_NotifyAll</name> <description> <para>Any change in job state will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in AWS Identity and Access Management (IAM). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_S3Resource</name> <description> <para>An array of <code>S3Resource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.S3Resource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ShippingOption</name> <description> <para>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows: - In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day. - In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. - In India, Snowball Edges are delivered in one to seven days. - In the US, you have access to one-day shipping and two-day shipping. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.ShippingOption</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnowballType</name> <description> <para>The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is <code>EDGE</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.SnowballType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_SnsTopicARN</name> <description> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> AWS Simple Notification Service (SNS) API action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AddressId</name> <description> <para>The ID for the address that you want the cluster shipped to.> </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="False" position="Named"> <name>Description</name> <description> <para>An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>. </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="False" 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="False" position="Named"> <name>ForwardingAddressId</name> <description> <para>The forwarding address ID for a cluster. This field is not supported in most regions. </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="False" position="Named"> <name>JobType</name> <description> <para>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.JobType</parameterValue> <type> <name>Amazon.Snowball.JobType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyARN</name> <description> <para>The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in AWS Key Management Service (AWS KMS). </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="False" position="Named"> <name>Notification_JobStatesToNotify</name> <description> <para>The list of job states that will trigger a notification for this job. </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="False" position="Named"> <name>Notification_NotifyAll</name> <description> <para>Any change in job state will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_SnsTopicARN</name> <description> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> AWS Simple Notification Service (SNS) API action. </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="False" position="Named"> <name>Resources_LambdaResource</name> <description> <para>The Python-language Lambda functions for this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.LambdaResource[]</parameterValue> <type> <name>Amazon.Snowball.Model.LambdaResource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_S3Resource</name> <description> <para>An array of <code>S3Resource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.S3Resource[]</parameterValue> <type> <name>Amazon.Snowball.Model.S3Resource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in AWS Identity and Access Management (IAM). </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="False" position="Named"> <name>ShippingOption</name> <description> <para>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows: - In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day. - In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. - In India, Snowball Edges are delivered in one to seven days. - In the US, you have access to one-day shipping and two-day shipping. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.ShippingOption</parameterValue> <type> <name>Amazon.Snowball.ShippingOption</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnowballType</name> <description> <para>The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is <code>EDGE</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.SnowballType</parameterValue> <type> <name>Amazon.Snowball.SnowballType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Snowball.Model.CreateClusterResponse) 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=New-SNOWCluster.html&tocid=New-SNOWCluster</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>New-SNOWJob</name> <description> <para>Invokes the CreateJob operation against AWS Import/Export Snowball.</para> </description> <verb>New</verb> <noun>SNOWJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the <code>clusterId</code> value; the other job attributes are inherited from the cluster. </para> </description> <syntax> <syntaxItem> <name>New-SNOWJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AddressId</name> <description> <para>The ID for the address that you want the Snowball shipped to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClusterId</name> <description> <para>The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this <code>clusterId</code> value. The other job attributes are inherited from the cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>Defines an optional description of this specific job, for example <code>Important Photos 2016-08-11</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ForwardingAddressId</name> <description> <para>The forwarding address ID for a job. This field is not supported in most regions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_JobStatesToNotify</name> <description> <para>The list of job states that will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>JobType</name> <description> <para>Defines the type of job that you're creating. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.JobType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyARN</name> <description> <para>The <code>KmsKeyARN</code> that you want to associate with this job. <code>KmsKeyARN</code>s are created using the <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> AWS Key Management Service (KMS) API action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_LambdaResource</name> <description> <para>The Python-language Lambda functions for this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.LambdaResource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_NotifyAll</name> <description> <para>Any change in job state will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The <code>RoleARN</code> that you want to associate with this job. <code>RoleArn</code>s are created using the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> AWS Identity and Access Management (IAM) API action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_S3Resource</name> <description> <para>An array of <code>S3Resource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.S3Resource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ShippingOption</name> <description> <para>The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows: - In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. - In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. - In India, Snowballs are delivered in one to seven days. - In the US, you have access to one-day shipping and two-day shipping. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.ShippingOption</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnowballCapacityPreference</name> <description> <para>If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.SnowballCapacity</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnowballType</name> <description> <para>The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is <code>EDGE</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.SnowballType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_SnsTopicARN</name> <description> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> AWS Simple Notification Service (SNS) API action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AddressId</name> <description> <para>The ID for the address that you want the Snowball shipped to. </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="False" position="Named"> <name>ClusterId</name> <description> <para>The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this <code>clusterId</code> value. The other job attributes are inherited from the cluster. </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="False" position="Named"> <name>Description</name> <description> <para>Defines an optional description of this specific job, for example <code>Important Photos 2016-08-11</code>. </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="False" 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="False" position="Named"> <name>ForwardingAddressId</name> <description> <para>The forwarding address ID for a job. This field is not supported in most regions. </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="False" position="Named"> <name>JobType</name> <description> <para>Defines the type of job that you're creating. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.JobType</parameterValue> <type> <name>Amazon.Snowball.JobType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyARN</name> <description> <para>The <code>KmsKeyARN</code> that you want to associate with this job. <code>KmsKeyARN</code>s are created using the <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> AWS Key Management Service (KMS) API action. </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="False" position="Named"> <name>Notification_JobStatesToNotify</name> <description> <para>The list of job states that will trigger a notification for this job. </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="False" position="Named"> <name>Notification_NotifyAll</name> <description> <para>Any change in job state will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_SnsTopicARN</name> <description> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> AWS Simple Notification Service (SNS) API action. </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="False" position="Named"> <name>Resources_LambdaResource</name> <description> <para>The Python-language Lambda functions for this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.LambdaResource[]</parameterValue> <type> <name>Amazon.Snowball.Model.LambdaResource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_S3Resource</name> <description> <para>An array of <code>S3Resource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.S3Resource[]</parameterValue> <type> <name>Amazon.Snowball.Model.S3Resource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The <code>RoleARN</code> that you want to associate with this job. <code>RoleArn</code>s are created using the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> AWS Identity and Access Management (IAM) API action. </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="False" position="Named"> <name>ShippingOption</name> <description> <para>The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows: - In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. - In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. - In India, Snowballs are delivered in one to seven days. - In the US, you have access to one-day shipping and two-day shipping. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.ShippingOption</parameterValue> <type> <name>Amazon.Snowball.ShippingOption</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnowballCapacityPreference</name> <description> <para>If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.SnowballCapacity</parameterValue> <type> <name>Amazon.Snowball.SnowballCapacity</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnowballType</name> <description> <para>The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is <code>EDGE</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.SnowballType</parameterValue> <type> <name>Amazon.Snowball.SnowballType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Snowball.Model.CreateJobResponse) 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=New-SNOWJob.html&tocid=New-SNOWJob</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Stop-SNOWCluster</name> <description> <para>Invokes the CancelCluster operation against AWS Import/Export Snowball.</para> </description> <verb>Stop</verb> <noun>SNOWCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Cancels a cluster job. You can only cancel a cluster job while it's in the <code>AwaitingQuorum</code> status. You'll have at least an hour after creating a cluster job to cancel it. </para> </description> <syntax> <syntaxItem> <name>Stop-SNOWCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ClusterId</name> <description> <para>The 39-character ID for the cluster that you want to cancel, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ClusterId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ClusterId</name> <description> <para>The 39-character ID for the cluster that you want to cancel, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ClusterId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ClusterId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Snowball.Model.CancelClusterResponse) 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=Stop-SNOWCluster.html&tocid=Stop-SNOWCluster</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Stop-SNOWJob</name> <description> <para>Invokes the CancelJob operation against AWS Import/Export Snowball.</para> </description> <verb>Stop</verb> <noun>SNOWJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Cancels the specified job. You can only cancel a job before its <code>JobState</code> value changes to <code>PreparingAppliance</code>. Requesting the <code>ListJobs</code> or <code>DescribeJob</code> action will return a job's <code>JobState</code> as part of the response element data returned. </para> </description> <syntax> <syntaxItem> <name>Stop-SNOWJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The 39-character job ID for the job that you want to cancel, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The 39-character job ID for the job that you want to cancel, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the JobId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Snowball.Model.CancelJobResponse) 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=Stop-SNOWJob.html&tocid=Stop-SNOWJob</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Update-SNOWCluster</name> <description> <para>Invokes the UpdateCluster operation against AWS Import/Export Snowball.</para> </description> <verb>Update</verb> <noun>SNOWCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>While a cluster's <code>ClusterState</code> value is in the <code>AwaitingQuorum</code> state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available. </para> </description> <syntax> <syntaxItem> <name>Update-SNOWCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ClusterId</name> <description> <para>The cluster ID of the cluster that you want to update, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AddressId</name> <description> <para>The ID of the updated <a>Address</a> object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The updated description of this cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ForwardingAddressId</name> <description> <para>The updated ID for the forwarding address for a cluster. This field is not supported in most regions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_JobStatesToNotify</name> <description> <para>The list of job states that will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_LambdaResource</name> <description> <para>The Python-language Lambda functions for this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.LambdaResource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_NotifyAll</name> <description> <para>Any change in job state will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in AWS Identity and Access Management (IAM). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_S3Resource</name> <description> <para>An array of <code>S3Resource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.S3Resource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ShippingOption</name> <description> <para>The updated shipping option value of this cluster's <a>ShippingDetails</a> object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.ShippingOption</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_SnsTopicARN</name> <description> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> AWS Simple Notification Service (SNS) API action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ClusterId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AddressId</name> <description> <para>The ID of the updated <a>Address</a> object. </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 (ByValue, )" position="1"> <name>ClusterId</name> <description> <para>The cluster ID of the cluster that you want to update, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>. </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="False" position="Named"> <name>Description</name> <description> <para>The updated description of this cluster. </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="False" 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="False" position="Named"> <name>ForwardingAddressId</name> <description> <para>The updated ID for the forwarding address for a cluster. This field is not supported in most regions. </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="False" position="Named"> <name>Notification_JobStatesToNotify</name> <description> <para>The list of job states that will trigger a notification for this job. </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="False" position="Named"> <name>Notification_NotifyAll</name> <description> <para>Any change in job state will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_SnsTopicARN</name> <description> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> AWS Simple Notification Service (SNS) API action. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ClusterId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Resources_LambdaResource</name> <description> <para>The Python-language Lambda functions for this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.LambdaResource[]</parameterValue> <type> <name>Amazon.Snowball.Model.LambdaResource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_S3Resource</name> <description> <para>An array of <code>S3Resource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.S3Resource[]</parameterValue> <type> <name>Amazon.Snowball.Model.S3Resource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in AWS Identity and Access Management (IAM). </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="False" position="Named"> <name>ShippingOption</name> <description> <para>The updated shipping option value of this cluster's <a>ShippingDetails</a> object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.ShippingOption</parameterValue> <type> <name>Amazon.Snowball.ShippingOption</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ClusterId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Snowball.Model.UpdateClusterResponse) 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=Update-SNOWCluster.html&tocid=Update-SNOWCluster</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Update-SNOWJob</name> <description> <para>Invokes the UpdateJob operation against AWS Import/Export Snowball.</para> </description> <verb>Update</verb> <noun>SNOWJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>While a job's <code>JobState</code> value is <code>New</code>, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available. </para> </description> <syntax> <syntaxItem> <name>Update-SNOWJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The job ID of the job that you want to update, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AddressId</name> <description> <para>The ID of the updated <a>Address</a> object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The updated description of this job's <a>JobMetadata</a> object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ForwardingAddressId</name> <description> <para>The updated ID for the forwarding address for a job. This field is not supported in most regions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_JobStatesToNotify</name> <description> <para>The list of job states that will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_LambdaResource</name> <description> <para>The Python-language Lambda functions for this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.LambdaResource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_NotifyAll</name> <description> <para>Any change in job state will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>AWS Identity and Access Management (IAM) API action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_S3Resource</name> <description> <para>An array of <code>S3Resource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.S3Resource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ShippingOption</name> <description> <para>The updated shipping option value of this job's <a>ShippingDetails</a> object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.ShippingOption</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnowballCapacityPreference</name> <description> <para>The updated <code>SnowballCapacityPreference</code> of this job's <a>JobMetadata</a> object. The 50 TB Snowballs are only available in the US regions. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.SnowballCapacity</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_SnsTopicARN</name> <description> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> AWS Simple Notification Service (SNS) API action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AddressId</name> <description> <para>The ID of the updated <a>Address</a> object. </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="False" position="Named"> <name>Description</name> <description> <para>The updated description of this job's <a>JobMetadata</a> object. </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="False" 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="False" position="Named"> <name>ForwardingAddressId</name> <description> <para>The updated ID for the forwarding address for a job. This field is not supported in most regions. </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 (ByValue, ByPropertyName)" position="1"> <name>JobId</name> <description> <para>The job ID of the job that you want to update, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>. </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="False" position="Named"> <name>Notification_JobStatesToNotify</name> <description> <para>The list of job states that will trigger a notification for this job. </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="False" position="Named"> <name>Notification_NotifyAll</name> <description> <para>Any change in job state will trigger a notification for this job. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_SnsTopicARN</name> <description> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the <a href="http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> AWS Simple Notification Service (SNS) API action. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Resources_LambdaResource</name> <description> <para>The Python-language Lambda functions for this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.LambdaResource[]</parameterValue> <type> <name>Amazon.Snowball.Model.LambdaResource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Resources_S3Resource</name> <description> <para>An array of <code>S3Resource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.Model.S3Resource[]</parameterValue> <type> <name>Amazon.Snowball.Model.S3Resource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleARN</name> <description> <para>The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>AWS Identity and Access Management (IAM) API action. </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="False" position="Named"> <name>ShippingOption</name> <description> <para>The updated shipping option value of this job's <a>ShippingDetails</a> object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.ShippingOption</parameterValue> <type> <name>Amazon.Snowball.ShippingOption</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnowballCapacityPreference</name> <description> <para>The updated <code>SnowballCapacityPreference</code> of this job's <a>JobMetadata</a> object. The 50 TB Snowballs are only available in the US regions. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Snowball.SnowballCapacity</parameterValue> <type> <name>Amazon.Snowball.SnowballCapacity</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the JobId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Snowball.Model.UpdateJobResponse) 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=Update-SNOWJob.html&tocid=Update-SNOWJob</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSImportExport/latest/DG/api-reference.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>Get-SSMParametersByPath</name> <description> <para>Invokes the GetParametersByPath operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMParametersByPath</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieve parameters in a specific hierarchy. For more information, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-working.html">Working with Systems Manager Parameters</a>. Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <code>MaxResults</code>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of results. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMParametersByPath</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Path</name> <description> <para>The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A hierarchy can have a maximum of five levels. Examples: /Environment/Test/DBString003 /Finance/Prod/IAD/OS/WinServ2016/license15 </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ParameterFilter</name> <description> <para>Filters to limit the request results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ParameterStringFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recursive</name> <description> <para>Retrieve all parameters within a hierarchy. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WithDecryption</name> <description> <para>Retrieve all parameters in a hierarchy with their value decrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>ParameterFilter</name> <description> <para>Filters to limit the request results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ParameterStringFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ParameterStringFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Path</name> <description> <para>The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A hierarchy can have a maximum of five levels. Examples: /Environment/Test/DBString003 /Finance/Prod/IAD/OS/WinServ2016/license15 </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="False" position="Named"> <name>Recursive</name> <description> <para>Retrieve all parameters within a hierarchy. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WithDecryption</name> <description> <para>Retrieve all parameters in a hierarchy with their value decrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Parameter</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Parameter objects. The service call response (type Amazon.SimpleSystemsManagement.Model.GetParametersByPathResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMParametersByPath.html&tocid=Get-SSMParametersByPath</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Add-SSMResourceTag</name> <description> <para>Invokes the AddTagsToResource operation against Amazon Simple Systems Management.</para> </description> <verb>Add</verb> <noun>SSMResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 10 tags. We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters. For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Amazon EC2 Resources</a> in the <i>Amazon EC2 User Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Add-SSMResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceId</name> <description> <para>The resource ID you want to tag. For the ManagedInstance, MaintenanceWindow, and PatchBaseline values, use the ID of the resource, such as mw-01234361858c9b57b for a Maintenance Window. For the Document and Parameter values, use the name of the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>Specifies the type of resource you are tagging. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ResourceTypeForTagging</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para> One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>ResourceId</name> <description> <para>The resource ID you want to tag. For the ManagedInstance, MaintenanceWindow, and PatchBaseline values, use the ID of the resource, such as mw-01234361858c9b57b for a Maintenance Window. For the Document and Parameter values, use the name of the resource. </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="False" position="Named"> <name>ResourceType</name> <description> <para>Specifies the type of resource you are tagging. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ResourceTypeForTagging</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.ResourceTypeForTagging</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para> One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Tag[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.AddTagsToResourceResponse) 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=Add-SSMResourceTag.html&tocid=Add-SSMResourceTag</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $option1 = @{Key="Stack";Value=@("Production")} PS C:\> Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $option1</code><remarks><para>Description</para><para>-----------</para><para>This example updates a maintenance window with new tags. There is no output if the command succeeds. The syntax used by this example requires PowerShell version 3 or later.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $tag1 = New-Object Amazon.SimpleSystemsManagement.Model.Tag PS C:\> $tag1.Key = "Stack" PS C:\> $tag1.Value = "Production" PS C:\> Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $tag1</code><remarks><para>Description</para><para>-----------</para><para>With PowerShell version 2, you must use New-Object to create each tag. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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>Edit-SSMDocumentPermission</name> <description> <para>Invokes the ModifyDocumentPermission operation against Amazon Simple Systems Management.</para> </description> <verb>Edit</verb> <noun>SSMDocumentPermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify <i>All</i> as the account ID. </para> </description> <syntax> <syntaxItem> <name>Edit-SSMDocumentPermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the document that you want to share. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccountIdsToAdd</name> <description> <para>The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccountIdsToRemove</name> <description> <para>The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or <i>All</i>. This action has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID to add and the same ID to remove, the system removes access to the document. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PermissionType</name> <description> <para>The permission type for the document. The permission type can be <i>Share</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentPermissionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccountIdsToAdd</name> <description> <para>The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. </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="False" position="Named"> <name>AccountIdsToRemove</name> <description> <para>The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or <i>All</i>. This action has a higher priority than <i>AccountIdsToAdd</i>. If you specify an account ID to add and the same ID to remove, the system removes access to the document. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the document that you want to share. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>PermissionType</name> <description> <para>The permission type for the document. The permission type can be <i>Share</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentPermissionType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.DocumentPermissionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Name parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.ModifyDocumentPermissionResponse) 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=Edit-SSMDocumentPermission.html&tocid=Edit-SSMDocumentPermission</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Edit-SSMDocumentPermission -Name "RunShellScript" -PermissionType "Share" -AccountIdsToAdd all</code><remarks><para>Description</para><para>-----------</para><para>This example adds "share" permissions to all accounts for a document. There is no output if the command succeeds.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> Edit-SSMDocumentPermission -Name "RunShellScriptNew" -PermissionType "Share" -AccountIdsToAdd "123456789012"</code><remarks><para>Description</para><para>-----------</para><para>This example adds "share" permissions to a specific account for a document. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMActivation</name> <description> <para>Invokes the DescribeActivations operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMActivation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMActivation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>A filter to view information about your activations. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.DescribeActivationsFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>A filter to view information about your activations. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.DescribeActivationsFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.DescribeActivationsFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.Activation</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Activation objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeActivationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMActivation.html&tocid=Get-SSMActivation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMActivation ActivationId : 08e51e79-1e36-446c-8e63-9458569c1363 CreatedDate : 3/1/2017 12:01:51 AM DefaultInstanceName : MyWebServers Description : ExpirationDate : 3/2/2017 12:01:51 AM Expired : False IamRole : AutomationRole RegistrationLimit : 10 RegistrationsCount : 0</code><remarks><para>Description</para><para>-----------</para><para>This example provides details about the activations on your account.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMAssociation</name> <description> <para>Invokes the DescribeAssociation operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMAssociation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the associations for the specified Systems Manager document or instance. </para> </description> <syntax> <syntaxItem> <name>Get-SSMAssociation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AssociationId</name> <description> <para>The association ID for which you want information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationVersion</name> <description> <para>Specify the association version to retrieve. To view the latest version, either specify <code>$LATEST</code> for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListInstanceAssociations. To get a list of versions for a specific association, use ListAssociationVersions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the Systems Manager document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AssociationId</name> <description> <para>The association ID for which you want 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="False" position="Named"> <name>AssociationVersion</name> <description> <para>Specify the association version to retrieve. To view the latest version, either specify <code>$LATEST</code> for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListInstanceAssociations. To get a list of versions for a specific association, use ListAssociationVersions. </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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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>Name</name> <description> <para>The name of the Systems Manager document. </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.SimpleSystemsManagement.Model.AssociationDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a AssociationDescription object. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeAssociationResponse) 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-SSMAssociation.html&tocid=Get-SSMAssociation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMAssociation -InstanceId "i-0000293ffd8c57862" -Name "AWS-UpdateSSMAgent" Name : AWS-UpdateSSMAgent InstanceId : i-0000293ffd8c57862 Date : 2/23/2017 6:55:22 PM Status.Name : Pending Status.Date : 2/20/2015 8:31:11 AM Status.Message : temp_status_change Status.AdditionalInfo : Additional-Config-Needed</code><remarks><para>Description</para><para>-----------</para><para>This example describes the association between an instance and a document.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMAssociationList</name> <description> <para>Invokes the ListAssociations operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMAssociationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the associations for the specified Systems Manager document or instance.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMAssociationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AssociationFilterList</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.AssociationFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AssociationFilterList</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.AssociationFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.AssociationFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.Association</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Association objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListAssociationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMAssociationList.html&tocid=Get-SSMAssociationList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $filter1 = @{Key="InstanceId";Value=@("i-0000293ffd8c57862")} PS C:\> Get-SSMAssociationList -AssociationFilterList $filter1 AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0 DocumentVersion : InstanceId : i-0000293ffd8c57862 LastExecutionDate : 2/20/2015 8:31:11 AM Name : AWS-UpdateSSMAgent Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview ScheduleExpression : Targets : {InstanceIds}</code><remarks><para>Description</para><para>-----------</para><para>This example lists all the associations for an instance. The syntax used by this example requires PowerShell version 3 or later.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $filter2 = @{Key="Name";Value=@("AWS-UpdateSSMAgent")} PS C:\> Get-SSMAssociationList -AssociationFilterList $filter2 AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0 DocumentVersion : InstanceId : i-0000293ffd8c57862 LastExecutionDate : 2/20/2015 8:31:11 AM Name : AWS-UpdateSSMAgent Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview ScheduleExpression : Targets : {InstanceIds}</code><remarks><para>Description</para><para>-----------</para><para>This example lists all associations for a configuration document. The syntax used by this example requires PowerShell version 3 or later.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\> $filter1 = New-Object Amazon.SimpleSystemsManagement.Model.AssociationFilter PS C:\> $filter1.Key = "InstanceId" PS C:\> $filter1.Value = "i-0000293ffd8c57862" PS C:\> Get-SSMAssociationList -AssociationFilterList $filter1 AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0 DocumentVersion : InstanceId : i-0000293ffd8c57862 LastExecutionDate : 2/20/2015 8:31:11 AM Name : AWS-UpdateSSMAgent Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview ScheduleExpression : Targets : {InstanceIds}</code><remarks><para>Description</para><para>-----------</para><para>With PowerShell version 2, you must use New-Object to create each filter.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMAssociationVersionList</name> <description> <para>Invokes the ListAssociationVersions operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMAssociationVersionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves all versions of an association for a specific association ID.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMAssociationVersionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AssociationId</name> <description> <para>The association ID for which you want to view all versions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AssociationId</name> <description> <para>The association ID for which you want to view all versions. </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="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.AssociationVersionInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of AssociationVersionInfo objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListAssociationVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMAssociationVersionList.html&tocid=Get-SSMAssociationVersionList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Get-SSMAutomationExecution</name> <description> <para>Invokes the GetAutomationExecution operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMAutomationExecution</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get detailed information about a particular Automation execution. </para> </description> <syntax> <syntaxItem> <name>Get-SSMAutomationExecution</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AutomationExecutionId</name> <description> <para>The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AutomationExecutionId</name> <description> <para>The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated. </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.SimpleSystemsManagement.Model.AutomationExecution</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a AutomationExecution object. The service call response (type Amazon.SimpleSystemsManagement.Model.GetAutomationExecutionResponse) 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-SSMAutomationExecution.html&tocid=Get-SSMAutomationExecution</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909" AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909 AutomationExecutionStatus : Failed DocumentName : AWS-UpdateLinuxAmi DocumentVersion : 1 ExecutionEndTime : 2/22/2017 9:17:08 PM ExecutionStartTime : 2/22/2017 9:17:02 PM FailureMessage : Step launchInstance failed maximum allowed times. You are not authorized to perform this operation. Encoded authorization failure message: B_V2QyyN7NhSZQYpmVzpEc4oSnj2GLTNYnXUHsTbqJkNMoDgubmbtthLmZyaiUYekORIrA42-fv1x-04q5Fjff6glh Yb6TI5b0GQeeNrpwNvpDzmO-PSR1swlAbg9fdM9BcNjyrznspUkWpuKu9EC1Ou6v3OXU1KC9nZ7mPlWMFZNkSioQqpwWEvMw-GZktsQzm67qOhUhBNOLWYhbS pkfiqzY-5nw3S0obx30fhd3EJa5O_-GjV_a0nFXQJa70ik40bFOrEh3MtCSbrQT6--DvFy_FQ8TKvkIXadyVskeJI84XOF5WmA60f1pi5GI08i-nRfZS6oDeU gELBjjoFKD8s3L2aI0B6umWVxnQOjqhQRxwJ53b54sZJ2PW3v_mtg9-q0CK0ezS3xfh_y0ilaUGOAZG-xjQFuvU_JZedWpla3xi-MZsmblAifBI (Service: AmazonEC2; Status Code: 403; Error Code: UnauthorizedOperation; Request ID: 6a002f94-ba37-43fd-99e6-39517715fce5) Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]} Parameters : {[AutomationAssumeRole, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [InstanceIamRole, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [SourceAmiId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]} StepExecutions : {launchInstance, updateOSSoftware, stopInstance, createImage...}</code><remarks><para>Description</para><para>-----------</para><para>This example displays the details of an Automation Execution.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMAutomationExecutionList</name> <description> <para>Invokes the DescribeAutomationExecutions operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMAutomationExecutionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Provides details about all active and terminated Automation executions.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMAutomationExecutionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Filters used to limit the scope of executions that are requested. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.AutomationExecutionFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Filters used to limit the scope of executions that are requested. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.AutomationExecutionFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.AutomationExecutionFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.AutomationExecutionMetadata</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of AutomationExecutionMetadata objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeAutomationExecutionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMAutomationExecutionList.html&tocid=Get-SSMAutomationExecutionList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMAutomationExecutionList AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909 AutomationExecutionStatus : Failed DocumentName : AWS-UpdateLinuxAmi DocumentVersion : 1 ExecutedBy : admin ExecutionEndTime : 2/22/2017 9:17:08 PM ExecutionStartTime : 2/22/2017 9:17:02 PM LogFile : Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}</code><remarks><para>Description</para><para>-----------</para><para>This example describes all active and terminated Automation Executions associated with your account.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMAvailablePatch</name> <description> <para>Invokes the DescribeAvailablePatches operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMAvailablePatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all patches that could possibly be included in a patch baseline.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMAvailablePatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Filters used to scope down the returned patches. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patches to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Filters used to scope down the returned patches. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patches to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.Patch</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Patch objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeAvailablePatchesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMAvailablePatch.html&tocid=Get-SSMAvailablePatch</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $filter1 = @{Key="PRODUCT";Values=@("WindowsServer2012")} PS C:\> $filter2 = @{Key="MSRC_SEVERITY";Values=@("Critical")} PS C:\> Get-SSMAvailablePatch -Filter $filter1,$filter2 Classification : SecurityUpdates ContentUrl : https://support.microsoft.com/en-us/kb/2727528 Description : A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to restart your system. Id : 1eb507be-2040-4eeb-803d-abc55700b715 KbNumber : KB2727528 Language : All MsrcNumber : MS12-072 MsrcSeverity : Critical Product : WindowsServer2012 ProductFamily : Windows ReleaseDate : 11/13/2012 6:00:00 PM Title : Security Update for Windows Server 2012 (KB2727528) Vendor : Microsoft ...</code><remarks><para>Description</para><para>-----------</para><para>This example gets all available patches for Windows Server 2012 that have a MSRC severity of Critical. The syntax used by this example requires PowerShell version 3 or later.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter PS C:\> $filter1.Key = "PRODUCT" PS C:\> $filter1.Values = "WindowsServer2012" PS C:\> $filter2 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter PS C:\> $filter2.Key = "MSRC_SEVERITY" PS C:\> $filter2.Values = "Critical" PS C:\> Get-SSMAvailablePatch -Filter $filter1,$filter2</code><remarks><para>Description</para><para>-----------</para><para>With PowerShell version 2, you must use New-Object to create each filter.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMCommand</name> <description> <para>Invokes the ListCommands operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMCommand</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the commands requested by users of the AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMCommand</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>(Optional) Lists commands issued against this instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CommandId</name> <description> <para>(Optional) If provided, lists only the specified command. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>(Optional) One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.CommandFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>(Optional) The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CommandId</name> <description> <para>(Optional) If provided, lists only the specified command. </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="False" position="Named"> <name>Filter</name> <description> <para>(Optional) One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.CommandFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.CommandFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>(Optional) Lists commands issued against this instance ID. </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="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>(Optional) The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.Command</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Command objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListCommandsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMCommand.html&tocid=Get-SSMCommand</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMCommand CommandId : 4b75a163-d39a-4d97-87c9-98ae52c6be35 Comment : Apply association with id at update time: 4cc73e42-d5ae-4879-84f8-57e09c0efcd0 CompletedCount : 1 DocumentName : AWS-RefreshAssociation ErrorCount : 0 ExpiresAfter : 2/24/2017 3:19:08 AM InstanceIds : {i-0cb2b964d3e14fd9f} MaxConcurrency : 50 MaxErrors : 0 NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig OutputS3BucketName : OutputS3KeyPrefix : OutputS3Region : Parameters : {[associationIds, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]} RequestedDateTime : 2/24/2017 3:18:08 AM ServiceRole : Status : Success StatusDetails : Success TargetCount : 1 Targets : {}</code><remarks><para>Description</para><para>-----------</para><para>This example lists all commands requested.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> Get-SSMCommand -CommandId "4b75a163-d39a-4d97-87c9-98ae52c6be35"</code><remarks><para>Description</para><para>-----------</para><para>This example gets the status of a specific command.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMCommandInvocation</name> <description> <para>Invokes the ListCommandInvocations operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMCommandInvocation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMCommandInvocation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>(Optional) The command execution details for a specific instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CommandId</name> <description> <para>(Optional) The invocations for a specific command ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Detail</name> <description> <para>(Optional) If set this returns the response of the command executions and any command output. By default this is set to False. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>(Optional) One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.CommandFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>(Optional) The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CommandId</name> <description> <para>(Optional) The invocations for a specific command ID. </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="False" position="Named"> <name>Detail</name> <description> <para>(Optional) If set this returns the response of the command executions and any command output. By default this is set to False. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>(Optional) One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.CommandFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.CommandFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>(Optional) The command execution details for a specific instance ID. </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="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>(Optional) The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.CommandInvocation</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of CommandInvocation objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListCommandInvocationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMCommandInvocation.html&tocid=Get-SSMCommandInvocation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMCommandInvocation -CommandId "b8eac879-0541-439d-94ec-47a80d554f44" -Detail $true CommandId : b8eac879-0541-439d-94ec-47a80d554f44 CommandPlugins : {aws:runShellScript} Comment : IP config DocumentName : AWS-RunShellScript InstanceId : i-0cb2b964d3e14fd9f InstanceName : NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig RequestedDateTime : 2/22/2017 8:13:16 PM ServiceRole : StandardErrorUrl : StandardOutputUrl : Status : Success StatusDetails : Success TraceOutput :</code><remarks><para>Description</para><para>-----------</para><para>This example lists all the invocations of a command.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMCommandInvocationDetail</name> <description> <para>Invokes the GetCommandInvocation operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMCommandInvocationDetail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns detailed information about command execution for an invocation or plugin. </para> </description> <syntax> <syntaxItem> <name>Get-SSMCommandInvocationDetail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CommandId</name> <description> <para>(Required) The parent command ID of the invocation plugin. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PluginName</name> <description> <para>(Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CommandId</name> <description> <para>(Required) The parent command ID of the invocation plugin. </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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager. </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>PluginName</name> <description> <para>(Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned. </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.SimpleSystemsManagement.Model.GetCommandInvocationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetCommandInvocationResponse 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-SSMCommandInvocationDetail.html&tocid=Get-SSMCommandInvocationDetail</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMCommandInvocationDetail -InstanceId "i-0cb2b964d3e14fd9f" -CommandId "b8eac879-0541-439d-94ec-47a80d554f44" CommandId : b8eac879-0541-439d-94ec-47a80d554f44 Comment : IP config DocumentName : AWS-RunShellScript ExecutionElapsedTime : PT0.004S ExecutionEndDateTime : 2017-02-22T20:13:16.651Z ExecutionStartDateTime : 2017-02-22T20:13:16.651Z InstanceId : i-0cb2b964d3e14fd9f PluginName : aws:runShellScript ResponseCode : 0 StandardErrorContent : StandardErrorUrl : StandardOutputContent : StandardOutputUrl : Status : Success StatusDetails : Success</code><remarks><para>Description</para><para>-----------</para><para>This example displays the details of a command executed on an instance.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMComplianceItemsList</name> <description> <para>Invokes the ListComplianceItems operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMComplianceItemsList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMComplianceItemsList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more compliance filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ResourceId</name> <description> <para>The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of resource from which to get compliance information. Currently, the only supported resource type is <code>ManagedInstance</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more compliance filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>ResourceId</name> <description> <para>The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of resource from which to get compliance information. Currently, the only supported resource type is <code>ManagedInstance</code>. </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.SimpleSystemsManagement.Model.ComplianceItem</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ComplianceItem objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListComplianceItemsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMComplianceItemsList.html&tocid=Get-SSMComplianceItemsList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Get-SSMComplianceSummariesList</name> <description> <para>Invokes the ListComplianceSummaries operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMComplianceSummariesList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMComplianceSummariesList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more compliance or inventory filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more compliance or inventory filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.ComplianceSummaryItem</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ComplianceSummaryItem objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListComplianceSummariesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMComplianceSummariesList.html&tocid=Get-SSMComplianceSummariesList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Get-SSMDefaultPatchBaseline</name> <description> <para>Invokes the GetDefaultPatchBaseline operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMDefaultPatchBaseline</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. </para> </description> <syntax> <syntaxItem> <name>Get-SSMDefaultPatchBaseline</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OperatingSystem</name> <description> <para>Returns the default patch baseline for the specified operating system. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.OperatingSystem</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OperatingSystem</name> <description> <para>Returns the default patch baseline for the specified operating system. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.OperatingSystem</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.OperatingSystem</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.GetDefaultPatchBaselineResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetDefaultPatchBaselineResponse 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-SSMDefaultPatchBaseline.html&tocid=Get-SSMDefaultPatchBaseline</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMDefaultPatchBaseline arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966</code><remarks><para>Description</para><para>-----------</para><para>This example displays the default patch baseline.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMDeployablePatchSnapshotForInstance</name> <description> <para>Invokes the GetDeployablePatchSnapshotForInstance operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMDeployablePatchSnapshotForInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document. </para> </description> <syntax> <syntaxItem> <name>Get-SSMDeployablePatchSnapshotForInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SnapshotId</name> <description> <para>The user-defined snapshot ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InstanceId</name> <description> <para>The ID of the instance for which the appropriate patch snapshot should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InstanceId</name> <description> <para>The ID of the instance for which the appropriate patch snapshot should be retrieved. </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 (ByValue, ByPropertyName)" position="1"> <name>SnapshotId</name> <description> <para>The user-defined snapshot ID. </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.SimpleSystemsManagement.Model.GetDeployablePatchSnapshotForInstanceResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetDeployablePatchSnapshotForInstanceResponse 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-SSMDeployablePatchSnapshotForInstance.html&tocid=Get-SSMDeployablePatchSnapshotForInstance</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f" InstanceId SnapshotDownloadUrl ---------- ------------------- i-0cb2b964d3e14fd9f https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...1692/4681775b-098f-4435...</code><remarks><para>Description</para><para>-----------</para><para>This example displays the current snapshot for the patch baseline used by an Instance. This command must be run from the instance using the instance credentials. To ensure it uses the instance credentials, run "aws configure" and only specify the region of your instance but leave the Access Key and Secret Key fields blank.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> (Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f").SnapshotDownloadUrl https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...</code><remarks><para>Description</para><para>-----------</para><para>This example shows how to get the full SnapshotDownloadUrl.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMDocument</name> <description> <para>Invokes the GetDocument operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMDocument</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets the contents of the specified Systems Manager document. </para> </description> <syntax> <syntaxItem> <name>Get-SSMDocument</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The document version for which you want 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>Name</name> <description> <para>The name of the Systems Manager document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The document version for which you want 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>Name</name> <description> <para>The name of the Systems Manager document. </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.SimpleSystemsManagement.Model.GetDocumentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetDocumentResponse 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-SSMDocument.html&tocid=Get-SSMDocument</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMDocument -Name "RunShellScript" Content ------- {...</code><remarks><para>Description</para><para>-----------</para><para>This example returns the content of a document.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> (Get-SSMDocument -Name "RunShellScript").Content { "schemaVersion":"2.0", "description":"Run an updated script", "parameters":{ "commands":{ "type":"StringList", "description":"(Required) Specify a shell script or a command to run.", "minItems":1, "displayType":"textarea" } }, "mainSteps":[ { "action":"aws:runShellScript", "name":"runShellScript", "inputs":{ "commands":"{{ commands }}" } }, { "action":"aws:runPowerShellScript", "name":"runPowerShellScript", "inputs":{ "commands":"{{ commands }}" } } ] }</code><remarks><para>Description</para><para>-----------</para><para>This example displays the complete contents of a document.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMDocumentDescription</name> <description> <para>Invokes the DescribeDocument operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMDocumentDescription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the specified Systems Manager document. </para> </description> <syntax> <syntaxItem> <name>Get-SSMDocumentDescription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The document version for which you want information. Can be a specific version or the default version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the Systems Manager document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The document version for which you want information. Can be a specific version or the default version. </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>Name</name> <description> <para>The name of the Systems Manager document. </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.SimpleSystemsManagement.Model.DocumentDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DocumentDescription object. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeDocumentResponse) 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-SSMDocumentDescription.html&tocid=Get-SSMDocumentDescription</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMDocumentDescription -Name "RunShellScript" CreatedDate : 2/24/2017 5:25:13 AM DefaultVersion : 1 Description : Run an updated script DocumentType : Command DocumentVersion : 1 Hash : f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b HashType : Sha256 LatestVersion : 1 Name : RunShellScript Owner : 123456789012 Parameters : {commands} PlatformTypes : {Linux} SchemaVersion : 2.0 Sha1 : Status : Active</code><remarks><para>Description</para><para>-----------</para><para>This example returns information about a document.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMDocumentList</name> <description> <para>Invokes the ListDocuments operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMDocumentList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes one or more of your Systems Manager documents.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMDocumentList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentFilterList</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.DocumentFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.DocumentKeyValuesFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentFilterList</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.DocumentFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.DocumentFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.DocumentKeyValuesFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.DocumentKeyValuesFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.DocumentIdentifier</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DocumentIdentifier objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListDocumentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMDocumentList.html&tocid=Get-SSMDocumentList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMDocumentList DocumentType : Command DocumentVersion : 1 Name : AWS-ApplyPatchBaseline Owner : Amazon PlatformTypes : {Windows} SchemaVersion : 1.2 DocumentType : Command DocumentVersion : 1 Name : AWS-ConfigureAWSPackage Owner : Amazon PlatformTypes : {Windows, Linux} SchemaVersion : 2.0 DocumentType : Command DocumentVersion : 1 Name : AWS-ConfigureCloudWatch Owner : Amazon PlatformTypes : {Windows} SchemaVersion : 1.2 ...</code><remarks><para>Description</para><para>-----------</para><para>Lists all the configuration documents in your account.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMDocumentPermission</name> <description> <para>Invokes the DescribeDocumentPermission operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMDocumentPermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (<i>All</i>). </para> </description> <syntax> <syntaxItem> <name>Get-SSMDocumentPermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the document for which you are the owner. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PermissionType</name> <description> <para>The permission type for the document. The permission type can be <i>Share</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentPermissionType</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the document for which you are the owner. </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="False" position="Named"> <name>PermissionType</name> <description> <para>The permission type for the document. The permission type can be <i>Share</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentPermissionType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.DocumentPermissionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeDocumentPermissionResponse) 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-SSMDocumentPermission.html&tocid=Get-SSMDocumentPermission</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMDocumentVersionList -Name "RunShellScript" CreatedDate DocumentVersion IsDefaultVersion Name ----------- --------------- ---------------- ---- 2/24/2017 5:25:13 AM 1 True RunShellScript</code><remarks><para>Description</para><para>-----------</para><para>This example lists all the versions for a document.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMDocumentVersionList</name> <description> <para>Invokes the ListDocumentVersions operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMDocumentVersionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>List all versions for a document.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMDocumentVersionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the document about which you want version information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the document about which you want version 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="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.DocumentVersionInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DocumentVersionInfo objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListDocumentVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMDocumentVersionList.html&tocid=Get-SSMDocumentVersionList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMDocumentPermission -Name "RunShellScript" -PermissionType "Share" all</code><remarks><para>Description</para><para>-----------</para><para>This example returns the permission list for a document.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMEffectiveInstanceAssociationList</name> <description> <para>Invokes the DescribeEffectiveInstanceAssociations operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMEffectiveInstanceAssociationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>All associations for the instance(s).<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMEffectiveInstanceAssociationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID for which you want to view all associations. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID for which you want to view all associations. </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="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.InstanceAssociation</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of InstanceAssociation objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeEffectiveInstanceAssociationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMEffectiveInstanceAssociationList.html&tocid=Get-SSMEffectiveInstanceAssociationList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5 AssociationId Content ------------- ------- d8617c07-2079-4c18-9847-1655fc2698b0 {...</code><remarks><para>Description</para><para>-----------</para><para>This example describes the effective associations for an instance.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> (Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5).Content { "schemaVersion": "1.2", "description": "Update the Amazon SSM Agent to the latest version or specified version.", "parameters": { "version": { "default": "", "description": "(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agen t will be updated to the latest version.", "type": "String" }, "allowDowngrade": { "default": "false", "description": "(Optional) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.", "type": "String", "allowedValues": [ "true", "false" ] } }, "runtimeConfig": { "aws:updateSsmAgent": { "properties": [ { "agentName": "amazon-ssm-agent", "source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json", "allowDowngrade": "{{ allowDowngrade }}", "targetVersion": "{{ version }}" } ] } } }</code><remarks><para>Description</para><para>-----------</para><para>This example displays the contents of the effective associations for an instance.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMEffectivePatchesForPatchBaseline</name> <description> <para>Invokes the DescribeEffectivePatchesForPatchBaseline operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMEffectivePatchesForPatchBaseline</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMEffectivePatchesForPatchBaseline</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to retrieve the effective patches for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patches to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to retrieve the effective patches for. </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="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patches to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.EffectivePatch</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of EffectivePatch objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeEffectivePatchesForPatchBaselineResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMEffectivePatchesForPatchBaseline.html&tocid=Get-SSMEffectivePatchesForPatchBaseline</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1 Patch PatchStatus ----- ----------- Amazon.SimpleSystemsManagement.Model.Patch Amazon.SimpleSystemsManagement.Model.PatchStatus</code><remarks><para>Description</para><para>-----------</para><para>This example lists all patch baselines, with a maximum result list of 1.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> (Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1).PatchStatus ApprovalDate DeploymentStatus ------------ ---------------- 12/21/2010 6:00:00 PM APPROVED</code><remarks><para>Description</para><para>-----------</para><para>This example displays the patch status for all patch baselines, with a maximum result list of 1.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMInstanceAssociationsStatus</name> <description> <para>Invokes the DescribeInstanceAssociationsStatus operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMInstanceAssociationsStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The status of the associations for the instance(s).<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMInstanceAssociationsStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance IDs for which you want association status information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance IDs for which you want association status 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="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.InstanceAssociationStatusInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of InstanceAssociationStatusInfo objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeInstanceAssociationsStatusResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMInstanceAssociationsStatus.html&tocid=Get-SSMInstanceAssociationsStatus</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMInstanceAssociationsStatus -InstanceId "i-0000293ffd8c57862" AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0 DetailedStatus : Pending DocumentVersion : 1 ErrorCode : ExecutionDate : 2/20/2015 8:31:11 AM ExecutionSummary : temp_status_change InstanceId : i-0000293ffd8c57862 Name : AWS-UpdateSSMAgent OutputUrl : Status : Pending</code><remarks><para>Description</para><para>-----------</para><para>This example shows details of the associations for an instance.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMInstanceInformation</name> <description> <para>Invokes the DescribeInstanceInformation operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMInstanceInformation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMInstanceInformation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InstanceInformationStringFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstanceInformationFilterList</name> <description> <para>One or more filters. Use a filter to return a more specific list of instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InstanceInformationFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InstanceInformationStringFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.InstanceInformationStringFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstanceInformationFilterList</name> <description> <para>One or more filters. Use a filter to return a more specific list of instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InstanceInformationFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.InstanceInformationFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.InstanceInformation</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of InstanceInformation objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeInstanceInformationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMInstanceInformation.html&tocid=Get-SSMInstanceInformation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMInstanceInformation ActivationId : AgentVersion : 2.0.672.0 AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview AssociationStatus : Success ComputerName : ip-172-31-44-222.us-west-2.compute.internal IamRole : InstanceId : i-0cb2b964d3e14fd9f IPAddress : 172.31.44.222 IsLatestVersion : True LastAssociationExecutionDate : 2/24/2017 3:18:09 AM LastPingDateTime : 2/24/2017 3:35:03 AM LastSuccessfulAssociationExecutionDate : 2/24/2017 3:18:09 AM Name : PingStatus : ConnectionLost PlatformName : Amazon Linux AMI PlatformType : Linux PlatformVersion : 2016.09 RegistrationDate : 1/1/0001 12:00:00 AM ResourceType : EC2Instance</code><remarks><para>Description</para><para>-----------</para><para>This example shows details of each of your instances.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMInstancePatch</name> <description> <para>Invokes the DescribeInstancePatches operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMInstancePatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMInstancePatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID of the instance whose patch state information should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string between 1 and 256 characters) </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patches to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string between 1 and 256 characters) </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID of the instance whose patch state information should be retrieved. </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="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patches to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.PatchComplianceData</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PatchComplianceData objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMInstancePatch.html&tocid=Get-SSMInstancePatch</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMInstancePatch -InstanceId "i-08ee91c0b17045407"</code><remarks><para>Description</para><para>-----------</para><para>This example gets the patch compliance details for an instance.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMInstancePatchState</name> <description> <para>Invokes the DescribeInstancePatchStates operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMInstancePatchState</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the high-level patch state of one or more instances.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMInstancePatchState</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InstanceId</name> <description> <para>The ID of the instance whose patch state information should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of instances to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InstanceId</name> <description> <para>The ID of the instance whose patch state information should be retrieved. </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="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of instances to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.InstancePatchState</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of InstancePatchState objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchStatesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMInstancePatchState.html&tocid=Get-SSMInstancePatchState</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407"</code><remarks><para>Description</para><para>-----------</para><para>This example gets the patch summary states for an instance.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407","i-09a618aec652973a9"</code><remarks><para>Description</para><para>-----------</para><para>This example gets the patch summary states for two instances.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMInstancePatchStatesForPatchGroup</name> <description> <para>Invokes the DescribeInstancePatchStatesForPatchGroup operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMInstancePatchStatesForPatchGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the high-level patch state for the instances in the specified patch group.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMInstancePatchStatesForPatchGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PatchGroup</name> <description> <para>The name of the patch group for which the patch state information should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Each entry in the array is a structure containing: Key (string between 1 and 200 characters) Values (array containing a single string) Type (string "Equal", "NotEqual", "LessThan", "GreaterThan") </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InstancePatchStateFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patches to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Each entry in the array is a structure containing: Key (string between 1 and 200 characters) Values (array containing a single string) Type (string "Equal", "NotEqual", "LessThan", "GreaterThan") </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InstancePatchStateFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.InstancePatchStateFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patches to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, ByPropertyName)" position="1"> <name>PatchGroup</name> <description> <para>The name of the patch group for which the patch state information should be retrieved. </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.SimpleSystemsManagement.Model.InstancePatchState</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of InstancePatchState objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeInstancePatchStatesForPatchGroupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMInstancePatchStatesForPatchGroup.html&tocid=Get-SSMInstancePatchStatesForPatchGroup</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMInstancePatchStatesForPatchGroup -PatchGroup "Production"</code><remarks><para>Description</para><para>-----------</para><para>This example gets the patch summary states per-instance for a patch group.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMInventory</name> <description> <para>Invokes the GetInventory operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMInventory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Query inventory information.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMInventory</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InventoryFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResultAttribute</name> <description> <para>The list of inventory item types to return. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ResultAttribute[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InventoryFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.InventoryFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>ResultAttribute</name> <description> <para>The list of inventory item types to return. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ResultAttribute[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ResultAttribute[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.InventoryResultEntity</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of InventoryResultEntity objects. The service call response (type Amazon.SimpleSystemsManagement.Model.GetInventoryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMInventory.html&tocid=Get-SSMInventory</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMInventory Data Id ---- -- {[AWS:InstanceInformation, Amazon.SimpleSystemsManagement.Model.InventoryResultItem]} i-0cb2b964d3e14fd9f</code><remarks><para>Description</para><para>-----------</para><para>This example gets the custom metadata for your inventory.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMInventoryEntriesList</name> <description> <para>Invokes the ListInventoryEntries operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMInventoryEntriesList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>A list of inventory items returned by the request. </para> </description> <syntax> <syntaxItem> <name>Get-SSMInventoryEntriesList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID for which you want inventory information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InventoryFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TypeName</name> <description> <para>The type of inventory item for which you want information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InventoryFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.InventoryFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID for which you want inventory 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="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>TypeName</name> <description> <para>The type of inventory item for which you want information. </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.SimpleSystemsManagement.Model.ListInventoryEntriesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.ListInventoryEntriesResponse 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-SSMInventoryEntriesList.html&tocid=Get-SSMInventoryEntriesList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo" CaptureTime : 2016-08-22T10:01:01Z Entries : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,System.String]} InstanceId : i-0cb2b964d3e14fd9f NextToken : SchemaVersion : 1.0 TypeName : Custom:RackInfo</code><remarks><para>Description</para><para>-----------</para><para>This example lists all the custom inventory entries for an instance.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> (Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo").Entries Key Value --- ----- RackLocation Bay B/Row C/Rack D/Shelf E</code><remarks><para>Description</para><para>-----------</para><para>This example lists the details.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMInventorySchema</name> <description> <para>Invokes the GetInventorySchema operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMInventorySchema</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMInventorySchema</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TypeName</name> <description> <para>The type of inventory item to return. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SubType</name> <description> <para>Returns the sub-type schema for a specified inventory type. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>SubType</name> <description> <para>Returns the sub-type schema for a specified inventory type. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TypeName</name> <description> <para>The type of inventory item to return. </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.SimpleSystemsManagement.Model.InventoryItemSchema</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of InventoryItemSchema objects. The service call response (type Amazon.SimpleSystemsManagement.Model.GetInventorySchemaResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMInventorySchema.html&tocid=Get-SSMInventorySchema</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMInventorySchema</code><remarks><para>Description</para><para>-----------</para><para>This example returns a list of inventory type names for the account.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindow</name> <description> <para>Invokes the GetMaintenanceWindow operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a Maintenance Window. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the desired Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the desired Maintenance Window. </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.SimpleSystemsManagement.Model.GetMaintenanceWindowResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowResponse 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-SSMMaintenanceWindow.html&tocid=Get-SSMMaintenanceWindow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" AllowUnassociatedTargets : False CreatedDate : 2/20/2017 6:14:05 PM Cutoff : 1 Duration : 2 Enabled : True ModifiedDate : 2/20/2017 6:14:05 PM Name : TestMaintWin Schedule : cron(0 */30 * * * ? *) WindowId : mw-03eb9db42890fb82d</code><remarks><para>Description</para><para>-----------</para><para>This example gets details about a maintenance window.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindowExecution</name> <description> <para>Invokes the GetMaintenanceWindowExecution operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowExecution</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves details about a specific task executed as part of a Maintenance Window execution. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowExecution</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution that includes the task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution that includes the task. </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.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionResponse 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-SSMMaintenanceWindowExecution.html&tocid=Get-SSMMaintenanceWindowExecution</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindowExecution -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355" EndTime : 2/21/2017 4:00:35 PM StartTime : 2/21/2017 4:00:34 PM Status : FAILED StatusDetails : One or more tasks in the orchestration failed. TaskIds : {ac0c6ae1-daa3-4a89-832e-d384503b6586} WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355</code><remarks><para>Description</para><para>-----------</para><para>This example lists information about a task executed as part of a maintenance window execution.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindowExecutionList</name> <description> <para>Invokes the DescribeMaintenanceWindowExecutions operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowExecutionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the executions of a Maintenance Window. This includes information about when the Maintenance Window was scheduled to be active, and information about tasks registered and run with the Maintenance Window.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowExecutionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window whose executions should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string is between 1 and 256 characters) The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Each entry in the array is a structure containing: Key (string, between 1 and 128 characters) Values (array of strings, each string is between 1 and 256 characters) The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window whose executions should be retrieved. </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.SimpleSystemsManagement.Model.MaintenanceWindowExecution</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of MaintenanceWindowExecution objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMMaintenanceWindowExecutionList.html&tocid=Get-SSMMaintenanceWindowExecutionList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" EndTime : 2/20/2017 6:30:17 PM StartTime : 2/20/2017 6:30:16 PM Status : FAILED StatusDetails : One or more tasks in the orchestration failed. WindowExecutionId : 6f3215cf-4101-4fa0-9b7b-9523269599c7 WindowId : mw-03eb9db42890fb82d</code><remarks><para>Description</para><para>-----------</para><para>This example lists all of the executions for a maintenance window.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $option1 = @{Key="ExecutedBefore";Values=@("2016-11-04T05:00:00Z")} PS C:\> Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1</code><remarks><para>Description</para><para>-----------</para><para>This example lists all of the executions for a maintenance window before a specified date.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\> $option1 = @{Key="ExecutedAfter";Values=@("2016-11-04T05:00:00Z")} PS C:\> Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1</code><remarks><para>Description</para><para>-----------</para><para>This example lists all of the executions for a maintenance window after a specified date.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindowExecutionTask</name> <description> <para>Invokes the GetMaintenanceWindowExecutionTask operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowExecutionTask</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the details about a specific task executed as part of a Maintenance Window execution. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowExecutionTask</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TaskId</name> <description> <para>The ID of the specific task execution in the Maintenance Window task that should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution that includes the task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TaskId</name> <description> <para>The ID of the specific task execution in the Maintenance Window task that should be retrieved. </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="False" position="Named"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution that includes the task. </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.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionTaskResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionTaskResponse 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-SSMMaintenanceWindowExecutionTask.html&tocid=Get-SSMMaintenanceWindowExecutionTask</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindowExecutionTask -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355" EndTime : 2/21/2017 4:00:35 PM MaxConcurrency : 1 MaxErrors : 1 Priority : 10 ServiceRole : arn:aws:iam::123456789012:role/MaintenanceWindowsRole StartTime : 2/21/2017 4:00:34 PM Status : FAILED StatusDetails : The maximum error count was exceeded. TaskArn : AWS-RunShellScript TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586 TaskParameters : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskPara meterValueExpression]} Type : RUN_COMMAND WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355</code><remarks><para>Description</para><para>-----------</para><para>This example lists information about a task that was part of a maintenance window execution.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindowExecutionTaskInvocation</name> <description> <para>Invokes the GetMaintenanceWindowExecutionTaskInvocation operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowExecutionTaskInvocation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowExecutionTaskInvocation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TaskId</name> <description> <para>The ID of the specific task in the Maintenance Window task that should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InvocationId</name> <description> <para>The invocation ID to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution for which the task is a part. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InvocationId</name> <description> <para>The invocation ID to retrieve. </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 (ByValue, ByPropertyName)" position="1"> <name>TaskId</name> <description> <para>The ID of the specific task in the Maintenance Window task that should be retrieved. </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="False" position="Named"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution for which the task is a part. </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.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionTaskInvocationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowExecutionTaskInvocationResponse 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-SSMMaintenanceWindowExecutionTaskInvocation.html&tocid=Get-SSMMaintenanceWindowExecutionTaskInvocation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Get-SSMMaintenanceWindowExecutionTaskInvocationList</name> <description> <para>Invokes the DescribeMaintenanceWindowExecutionTaskInvocations operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowExecutionTaskInvocationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowExecutionTaskInvocationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution the task is part of. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TaskId</name> <description> <para>The ID of the specific task in the Maintenance Window task that should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>TaskId</name> <description> <para>The ID of the specific task in the Maintenance Window task that should be retrieved. </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 (ByValue, )" position="1"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution the task is part of. </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.SimpleSystemsManagement.Model.MaintenanceWindowExecutionTaskInvocationIdentity</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of MaintenanceWindowExecutionTaskInvocationIdentity objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMMaintenanceWindowExecutionTaskInvocationList.html&tocid=Get-SSMMaintenanceWindowExecutionTaskInvocationList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindowExecutionTaskInvocationList -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355" EndTime : 2/21/2017 4:00:34 PM ExecutionId : InvocationId : e274b6e1-fe56-4e32-bd2a-8073c6381d8b OwnerInformation : Parameters : {"documentName":"AWS-RunShellScript","instanceIds":["i-0000293ffd8c57862"],"parameters":{"commands":["df"]},"maxConcurrency":"1", "maxErrors":"1"} StartTime : 2/21/2017 4:00:34 PM Status : FAILED StatusDetails : The instance IDs list contains an invalid entry. TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586 WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355 WindowTargetId :</code><remarks><para>Description</para><para>-----------</para><para>This example lists the invocations for a task executed as part of a maintenance window execution.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindowExecutionTaskList</name> <description> <para>Invokes the DescribeMaintenanceWindowExecutionTasks operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowExecutionTaskList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>For a given Maintenance Window execution, lists the tasks that were executed.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowExecutionTaskList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution whose task executions should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>WindowExecutionId</name> <description> <para>The ID of the Maintenance Window execution whose task executions should be retrieved. </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.SimpleSystemsManagement.Model.MaintenanceWindowExecutionTaskIdentity</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of MaintenanceWindowExecutionTaskIdentity objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowExecutionTasksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMMaintenanceWindowExecutionTaskList.html&tocid=Get-SSMMaintenanceWindowExecutionTaskList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindowExecutionTaskList -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355" EndTime : 2/21/2017 4:00:35 PM StartTime : 2/21/2017 4:00:34 PM Status : SUCCESS TaskArn : AWS-RunShellScript TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586 TaskType : RUN_COMMAND WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355</code><remarks><para>Description</para><para>-----------</para><para>This example lists the tasks associated with a maintenance window execution.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindowList</name> <description> <para>Invokes the DescribeMaintenanceWindows operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the Maintenance Windows in an AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Filter</name> <description> <para>Optional filters used to narrow down the scope of the returned Maintenance Windows. Supported filter keys are Name and Enabled. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Filter</name> <description> <para>Optional filters used to narrow down the scope of the returned Maintenance Windows. Supported filter keys are Name and Enabled. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.MaintenanceWindowIdentity</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of MaintenanceWindowIdentity objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMMaintenanceWindowList.html&tocid=Get-SSMMaintenanceWindowList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindowList Cutoff : 1 Duration : 4 Enabled : True Name : My-First-Maintenance-Window WindowId : mw-06d59c1a07c022145</code><remarks><para>Description</para><para>-----------</para><para>This example lists all maintenance windows on your account.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindowTarget</name> <description> <para>Invokes the DescribeMaintenanceWindowTargets operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowTarget</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the targets registered with the Maintenance Window.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowTarget</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window whose targets should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>WindowId</name> <description> <para>The ID of the Maintenance Window whose targets should be retrieved. </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.SimpleSystemsManagement.Model.MaintenanceWindowTarget</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of MaintenanceWindowTarget objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowTargetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMMaintenanceWindowTarget.html&tocid=Get-SSMMaintenanceWindowTarget</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindowTarget -WindowId "mw-06cf17cbefcb4bf4f" OwnerInformation : Single instance ResourceType : INSTANCE Targets : {InstanceIds} WindowId : mw-06cf17cbefcb4bf4f WindowTargetId : 350d44e6-28cc-44e2-951f-4b2c985838f6 OwnerInformation : Two instances in a list ResourceType : INSTANCE Targets : {InstanceIds} WindowId : mw-06cf17cbefcb4bf4f WindowTargetId : e078a987-2866-47be-bedd-d9cf49177d3a</code><remarks><para>Description</para><para>-----------</para><para>This example lists all of the targets for a maintenance window.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMMaintenanceWindowTask</name> <description> <para>Invokes the GetMaintenanceWindowTask operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowTask</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the tasks in a Maintenance Window. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowTask</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowTaskId</name> <description> <para>The Maintenance Window task ID to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The Maintenance Window ID that includes the task to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The Maintenance Window ID that includes the task to retrieve. </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 (ByValue, ByPropertyName)" position="1"> <name>WindowTaskId</name> <description> <para>The Maintenance Window task ID to retrieve. </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.SimpleSystemsManagement.Model.GetMaintenanceWindowTaskResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowTaskResponse 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-SSMMaintenanceWindowTask.html&tocid=Get-SSMMaintenanceWindowTask</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Get-SSMMaintenanceWindowTaskList</name> <description> <para>Invokes the DescribeMaintenanceWindowTasks operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMMaintenanceWindowTaskList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the tasks in a Maintenance Window.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMMaintenanceWindowTaskList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window whose tasks should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.MaintenanceWindowFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window whose tasks should be retrieved. </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.SimpleSystemsManagement.Model.MaintenanceWindowTask</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of MaintenanceWindowTask objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeMaintenanceWindowTasksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMMaintenanceWindowTaskList.html&tocid=Get-SSMMaintenanceWindowTaskList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMMaintenanceWindowTaskList -WindowId "mw-06cf17cbefcb4bf4f" LoggingInfo : MaxConcurrency : 1 MaxErrors : 1 Priority : 10 ServiceRoleArn : arn:aws:iam::123456789012:role/MaintenanceWindowsRole Targets : {InstanceIds} TaskArn : AWS-RunShellScript TaskParameters : {[commands, Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression]} Type : RUN_COMMAND WindowId : mw-06cf17cbefcb4bf4f WindowTaskId : a23e338d-ff30-4398-8aa3-09cd052ebf17</code><remarks><para>Description</para><para>-----------</para><para>This example lists all of the tasks for a maintenance window.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMParameter</name> <description> <para>Invokes the GetParameter operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get information about a parameter by using the parameter name. </para> </description> <syntax> <syntaxItem> <name>Get-SSMParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the parameter you want to query. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WithDecryption</name> <description> <para>Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the parameter you want to query. </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="False" position="Named"> <name>WithDecryption</name> <description> <para>Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Parameter</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Parameter object. The service call response (type Amazon.SimpleSystemsManagement.Model.GetParameterResponse) 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-SSMParameter.html&tocid=Get-SSMParameter</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Get-SSMParameterHistory</name> <description> <para>Invokes the GetParameterHistory operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMParameterHistory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Query a list of all parameters used by the AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMParameterHistory</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of a parameter you want to query. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WithDecryption</name> <description> <para>Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of a parameter you want to query. </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="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>WithDecryption</name> <description> <para>Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ParameterHistory</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ParameterHistory objects. The service call response (type Amazon.SimpleSystemsManagement.Model.GetParameterHistoryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMParameterHistory.html&tocid=Get-SSMParameterHistory</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMParameterHistory -Name "Welcome" Description : KeyId : LastModifiedDate : 3/3/2017 6:55:25 PM LastModifiedUser : arn:aws:iam::123456789012:user/admin Name : Welcome Type : String Value : helloWorld</code><remarks><para>Description</para><para>-----------</para><para>This example lists the value history for a parameter.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMParameterList</name> <description> <para>Invokes the DescribeParameters operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMParameterList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get information about a parameter. Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <code>MaxResults</code>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of results. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMParameterList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ParametersFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ParameterFilter</name> <description> <para>Filters to limit the request results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ParameterStringFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ParametersFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ParametersFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>ParameterFilter</name> <description> <para>Filters to limit the request results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ParameterStringFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ParameterStringFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ParameterMetadata</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ParameterMetadata objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribeParametersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMParameterList.html&tocid=Get-SSMParameterList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMParameterList Description : KeyId : LastModifiedDate : 3/3/2017 6:58:23 PM LastModifiedUser : arn:aws:iam::123456789012:user/admin Name : Welcome Type : String</code><remarks><para>Description</para><para>-----------</para><para>This example lists all parameters.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMParameterValue</name> <description> <para>Invokes the GetParameters operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMParameterValue</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get details of a parameter. </para> </description> <syntax> <syntaxItem> <name>Get-SSMParameterValue</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>Names of the parameters for which you want to query information. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WithDecryption</name> <description> <para>Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>Names of the parameters for which you want to query 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="False" position="Named"> <name>WithDecryption</name> <description> <para>Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.GetParametersResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetParametersResponse 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-SSMParameterValue.html&tocid=Get-SSMParameterValue</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMParameterValue -Name "Welcome" InvalidParameters Parameters ----------------- ---------- {} {Welcome}</code><remarks><para>Description</para><para>-----------</para><para>This example lists the values for a parameter.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> (Get-SSMParameterValue -Name "Welcome").Parameters Name Type Value ---- ---- ----- Welcome String Good day, Sunshine!</code><remarks><para>Description</para><para>-----------</para><para>This example lists the details of the value.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMPatchBaseline</name> <description> <para>Invokes the DescribePatchBaselines operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMPatchBaseline</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the patch baselines in your AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMPatchBaseline</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Each element in the array is a structure containing: Key: (string, "NAME_PREFIX" or "OWNER") Value: (array of strings, exactly 1 entry, between 1 and 255 characters) </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patch baselines to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Each element in the array is a structure containing: Key: (string, "NAME_PREFIX" or "OWNER") Value: (array of strings, exactly 1 entry, between 1 and 255 characters) </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patch baselines to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.PatchBaselineIdentity</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PatchBaselineIdentity objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribePatchBaselinesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMPatchBaseline.html&tocid=Get-SSMPatchBaseline</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMPatchBaseline BaselineDescription BaselineId BaselineName ------------------- ---------- ------------ Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultP... Baseline containing all updates approved for production systems pb-045f10b4f382baeda Production-B... Baseline containing all updates approved for production systems pb-0a2f1059b670ebd31 Production-B...</code><remarks><para>Description</para><para>-----------</para><para>This example lists all patch baselines.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $filter1 = @{Key="OWNER";Values=@("AWS")} PS C:\> Get-SSMPatchBaseline -Filter $filter1</code><remarks><para>Description</para><para>-----------</para><para>This example lists all patch baselines provided by AWS. The syntax used by this example requires PowerShell version 3 or later.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\> $filter1 = @{Key="OWNER";Values=@("Self")} PS C:\> Get-SSMPatchBaseline -Filter $filter1</code><remarks><para>Description</para><para>-----------</para><para>This example lists all patch baselines with you as the owner. The syntax used by this example requires PowerShell version 3 or later.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\> $filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter PS C:\> $filter1.Key = "OWNER" PS C:\> $filter1.Values = "AWS" PS C:\> Get-SSMPatchBaseline -Filter $filter1 BaselineDescription BaselineId BaselineName DefaultBaselin e ------------------- ---------- ------------ -------------- Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultPatchBaseline True</code><remarks><para>Description</para><para>-----------</para><para>With PowerShell version 2, you must use New-Object to create each tag.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMPatchBaselineDetail</name> <description> <para>Invokes the GetPatchBaseline operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMPatchBaselineDetail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about a patch baseline. </para> </description> <syntax> <syntaxItem> <name>Get-SSMPatchBaselineDetail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to retrieve. </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.SimpleSystemsManagement.Model.GetPatchBaselineResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetPatchBaselineResponse 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-SSMPatchBaselineDetail.html&tocid=Get-SSMPatchBaselineDetail</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMPatchBaselineDetail -BaselineId "pb-03da896ca3b68b639" ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup ApprovedPatches : {} BaselineId : pb-03da896ca3b68b639 CreatedDate : 3/3/2017 5:02:19 PM Description : Baseline containing all updates approved for production systems GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup ModifiedDate : 3/3/2017 5:02:19 PM Name : Production-Baseline PatchGroups : {} RejectedPatches : {}</code><remarks><para>Description</para><para>-----------</para><para>This example displays the details for a patch baseline.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMPatchBaselineForPatchGroup</name> <description> <para>Invokes the GetPatchBaselineForPatchGroup operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMPatchBaselineForPatchGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the patch baseline that should be used for the specified patch group. </para> </description> <syntax> <syntaxItem> <name>Get-SSMPatchBaselineForPatchGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OperatingSystem</name> <description> <para>Returns he operating system rule specified for patch groups using the patch baseline. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.OperatingSystem</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PatchGroup</name> <description> <para>The name of the patch group whose patch baseline should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OperatingSystem</name> <description> <para>Returns he operating system rule specified for patch groups using the patch baseline. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.OperatingSystem</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.OperatingSystem</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PatchGroup</name> <description> <para>The name of the patch group whose patch baseline should be retrieved. </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.SimpleSystemsManagement.Model.GetPatchBaselineForPatchGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.GetPatchBaselineForPatchGroupResponse 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-SSMPatchBaselineForPatchGroup.html&tocid=Get-SSMPatchBaselineForPatchGroup</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMPatchBaselineForPatchGroup -PatchGroup "Production" BaselineId PatchGroup ---------- ---------- pb-045f10b4f382baeda Production</code><remarks><para>Description</para><para>-----------</para><para>This example displays the patch baseline for a patch group.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMPatchGroup</name> <description> <para>Invokes the DescribePatchGroups operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMPatchGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all patch groups that have been registered with patch baselines.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMPatchGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patch groups to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of patch groups to return (per page). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token for the next set of items to return. (You received this token from a previous call.) <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.PatchGroupPatchBaselineMapping</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PatchGroupPatchBaselineMapping objects. The service call response (type Amazon.SimpleSystemsManagement.Model.DescribePatchGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMPatchGroup.html&tocid=Get-SSMPatchGroup</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMPatchGroup BaselineIdentity PatchGroup ---------------- ---------- Amazon.SimpleSystemsManagement.Model.PatchBaselineIdentity Production</code><remarks><para>Description</para><para>-----------</para><para>This example lists the patch group registrations.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMPatchGroupState</name> <description> <para>Invokes the DescribePatchGroupState operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMPatchGroupState</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns high-level aggregated patch compliance state for a patch group. </para> </description> <syntax> <syntaxItem> <name>Get-SSMPatchGroupState</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PatchGroup</name> <description> <para>The name of the patch group whose patch snapshot should be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PatchGroup</name> <description> <para>The name of the patch group whose patch snapshot should be retrieved. </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.SimpleSystemsManagement.Model.DescribePatchGroupStateResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.DescribePatchGroupStateResponse 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-SSMPatchGroupState.html&tocid=Get-SSMPatchGroupState</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMPatchGroupState -PatchGroup "Production" Instances : 4 InstancesWithFailedPatches : 1 InstancesWithInstalledOtherPatches : 4 InstancesWithInstalledPatches : 3 InstancesWithMissingPatches : 0 InstancesWithNotApplicablePatches : 0</code><remarks><para>Description</para><para>-----------</para><para>This example gets the high-level patch compliance summary for a patch group.</para><para /><para /></remarks> </example> </examples> </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>Get-SSMResourceComplianceSummariesList</name> <description> <para>Invokes the ListResourceComplianceSummaries operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMResourceComplianceSummariesList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMResourceComplianceSummariesList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>One or more filters. Use a filter to return a more specific list of results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ComplianceStringFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.ResourceComplianceSummaryItem</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ResourceComplianceSummaryItem objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListResourceComplianceSummariesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMResourceComplianceSummariesList.html&tocid=Get-SSMResourceComplianceSummariesList</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Get-SSMResourceDataSync</name> <description> <para>Invokes the ListResourceDataSync operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMResourceDataSync</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to <code>ListResourceDataSync</code>. You can limit the number of sync configurations returned by using the <code>MaxResults</code> parameter. To determine whether there are more sync configurations to list, check the value of <code>NextToken</code> in the output. If there are more sync configurations to list, you can request them by specifying the <code>NextToken</code> returned in the call to the parameter of a subsequent call. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SSMResourceDataSync</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token to start the list. Use this token to get the next set of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleSystemsManagement.Model.ResourceDataSyncItem</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ResourceDataSyncItem objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListResourceDataSyncResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SSMResourceDataSync.html&tocid=Get-SSMResourceDataSync</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Get-SSMResourceTag</name> <description> <para>Invokes the ListTagsForResource operation against Amazon Simple Systems Management.</para> </description> <verb>Get</verb> <noun>SSMResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of the tags assigned to the specified resource. </para> </description> <syntax> <syntaxItem> <name>Get-SSMResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceId</name> <description> <para>The resource ID for which you want to see a list of tags. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>Returns a list of tags for a specific resource type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ResourceTypeForTagging</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceId</name> <description> <para>The resource ID for which you want to see a list of tags. </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="False" position="Named"> <name>ResourceType</name> <description> <para>Returns a list of tags for a specific resource type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ResourceTypeForTagging</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.ResourceTypeForTagging</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Tag</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Tag objects. The service call response (type Amazon.SimpleSystemsManagement.Model.ListTagsForResourceResponse) 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-SSMResourceTag.html&tocid=Get-SSMResourceTag</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Get-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" Key Value --- ----- Stack Production</code><remarks><para>Description</para><para>-----------</para><para>This example lists the tags for a maintenance window.</para><para /><para /></remarks> </example> </examples> </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>New-SSMActivation</name> <description> <para>Invokes the CreateActivation operation against Amazon Simple Systems Management.</para> </description> <verb>New</verb> <noun>SSMActivation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html">Setting Up Systems Manager in Hybrid Environments</a>. </para> </description> <syntax> <syntaxItem> <name>New-SSMActivation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultInstanceName</name> <description> <para>The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A userdefined description of the resource that you want to register with Amazon EC2. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExpirationDate</name> <description> <para>The date by which this activation request should expire. The default value is 24 hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IamRole</name> <description> <para>The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrationLimit</name> <description> <para>Specify the maximum number of managed instances you want to register. The default value is 1 instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultInstanceName</name> <description> <para>The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources. </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="False" position="Named"> <name>Description</name> <description> <para>A userdefined description of the resource that you want to register with Amazon EC2. </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="False" position="Named"> <name>ExpirationDate</name> <description> <para>The date by which this activation request should expire. The default value is 24 hours. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>IamRole</name> <description> <para>The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. </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="False" position="Named"> <name>RegistrationLimit</name> <description> <para>Specify the maximum number of managed instances you want to register. The default value is 1 instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.CreateActivationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.CreateActivationResponse 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=New-SSMActivation.html&tocid=New-SSMActivation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> New-SSMActivation -DefaultInstanceName "MyWebServers" -IamRole "SSMAutomationRole" -RegistrationLimit 10 ActivationCode ActivationId -------------- ------------ KWChhOxBTiwDcKE9BlKC 08e51e79-1e36-446c-8e63-9458569c1363</code><remarks><para>Description</para><para>-----------</para><para>This example creates a managed instance.</para><para /><para /></remarks> </example> </examples> </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>New-SSMAssociation</name> <description> <para>Invokes the CreateAssociation operation against Amazon Simple Systems Management.</para> </description> <verb>New</verb> <noun>SSMAssociation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </description> <syntax> <syntaxItem> <name>New-SSMAssociation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationName</name> <description> <para>Specify a descriptive name for the association. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The document version you want to associate with the target(s). Can be a specific version or the default version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the Systems Manager document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Location_OutputS3BucketName</name> <description> <para>The name of the Amazon S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Location_OutputS3KeyPrefix</name> <description> <para>The Amazon S3 bucket subfolder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Location_OutputS3Region</name> <description> <para>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameter</name> <description> <para>The parameters for the documents runtime configuration. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ScheduleExpression</name> <description> <para>A cron expression when the association will be applied to the target(s). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>The targets (either instances or tags) for the association. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationName</name> <description> <para>Specify a descriptive name for the association. </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="False" position="Named"> <name>DocumentVersion</name> <description> <para>The document version you want to associate with the target(s). Can be a specific version or the default version. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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>Name</name> <description> <para>The name of the Systems Manager document. </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="False" position="Named"> <name>Parameter</name> <description> <para>The parameters for the documents runtime configuration. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Location_OutputS3BucketName</name> <description> <para>The name of the Amazon S3 bucket. </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="False" position="Named"> <name>S3Location_OutputS3KeyPrefix</name> <description> <para>The Amazon S3 bucket subfolder. </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="False" position="Named"> <name>S3Location_OutputS3Region</name> <description> <para>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. </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="False" position="Named"> <name>ScheduleExpression</name> <description> <para>A cron expression when the association will be applied to the target(s). </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="False" position="Named"> <name>Target</name> <description> <para>The targets (either instances or tags) for the association. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Target[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.AssociationDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a AssociationDescription object. The service call response (type Amazon.SimpleSystemsManagement.Model.CreateAssociationResponse) 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=New-SSMAssociation.html&tocid=New-SSMAssociation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> New-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent" Name : AWS-UpdateSSMAgent InstanceId : i-0000293ffd8c57862 Date : 2/23/2017 6:55:22 PM Status.Name : Associated Status.Date : 2/20/2015 8:31:11 AM Status.Message : Associated with AWS-UpdateSSMAgent Status.AdditionalInfo :</code><remarks><para>Description</para><para>-----------</para><para>This example associates a configuration document with an instance, using instance IDs.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $option1 = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")} PS C:\> New-SSMAssociation -Name "AWS-UpdateSSMAgent" -Target $option1 Name : AWS-UpdateSSMAgent InstanceId : Date : 3/1/2017 6:22:21 PM Status.Name : Status.Date : Status.Message : Status.AdditionalInfo :</code><remarks><para>Description</para><para>-----------</para><para>This example associates a configuration document with an instance, using targets.</para><para /><para /></remarks> </example> </examples> </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>New-SSMAssociationFromBatch</name> <description> <para>Invokes the CreateAssociationBatch operation against Amazon Simple Systems Management.</para> </description> <verb>New</verb> <noun>SSMAssociationFromBatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </description> <syntax> <syntaxItem> <name>New-SSMAssociationFromBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Entry</name> <description> <para>One or more associations. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchRequestEntry[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Entry</name> <description> <para>One or more associations. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchRequestEntry[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchRequestEntry[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchResponse 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=New-SSMAssociationFromBatch.html&tocid=New-SSMAssociationFromBatch</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")} PS C:\> $option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")} PS C:\> New-SSMAssociationFromBatch -Entry $option1,$option2 Failed Successful ------ ---------- {} {Amazon.SimpleSystemsManagement.Model.FailedCreateAssociation, Amazon.SimpleSystemsManagement.Model.FailedCreateAsso...</code><remarks><para>Description</para><para>-----------</para><para>This example associates a configuration document with multiple instances. The output returns a list of successful and failed operations, if applicable.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")} PS C:\> $option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")} PS C:\> (New-SSMAssociationFromBatch -Entry $option1,$option2).Successful</code><remarks><para>Description</para><para>-----------</para><para>This example will show the full details of a successful operation.</para><para /><para /></remarks> </example> </examples> </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>New-SSMDocument</name> <description> <para>Invokes the CreateDocument operation against Amazon Simple Systems Management.</para> </description> <verb>New</verb> <noun>SSMDocument</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a Systems Manager document. After you create a document, you can use CreateAssociation to associate it with one or more running instances. </para> </description> <syntax> <syntaxItem> <name>New-SSMDocument</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Content</name> <description> <para>A valid JSON string. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentType</name> <description> <para>The type of document to create. Valid document types include: Policy, Automation, and Command. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>A name for the Systems Manager document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Content</name> <description> <para>A valid JSON string. </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="False" position="Named"> <name>DocumentType</name> <description> <para>The type of document to create. Valid document types include: Policy, Automation, and Command. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.DocumentType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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>Name</name> <description> <para>A name for the Systems Manager document. </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.SimpleSystemsManagement.Model.DocumentDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DocumentDescription object. The service call response (type Amazon.SimpleSystemsManagement.Model.CreateDocumentResponse) 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=New-SSMDocument.html&tocid=New-SSMDocument</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> New-SSMDocument -Content (Get-Content -Raw "c:\temp\RunShellScript.json") -Name "RunShellScript" -DocumentType "Command" CreatedDate : 3/1/2017 1:21:33 AM DefaultVersion : 1 Description : Run an updated script DocumentType : Command DocumentVersion : 1 Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1 HashType : Sha256 LatestVersion : 1 Name : RunShellScript Owner : 809632081692 Parameters : {commands} PlatformTypes : {Linux} SchemaVersion : 2.0 Sha1 : Status : Creating</code><remarks><para>Description</para><para>-----------</para><para>This example creates a document in your account. The document must be in JSON format. For more information about writing a configuration document, see Configuration Document in the SSM API Reference.</para><para /><para /></remarks> </example> </examples> </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>New-SSMMaintenanceWindow</name> <description> <para>Invokes the CreateMaintenanceWindow operation against Amazon Simple Systems Management.</para> </description> <verb>New</verb> <noun>SSMMaintenanceWindow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new Maintenance Window. </para> </description> <syntax> <syntaxItem> <name>New-SSMMaintenanceWindow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowUnassociatedTarget</name> <description> <para>Enables a Maintenance Window task to execute on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Cutoff</name> <description> <para>The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The duration of the Maintenance Window in hours. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule</name> <description> <para>The schedule of the Maintenance Window in the form of a cron or rate expression. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowUnassociatedTarget</name> <description> <para>Enables a Maintenance Window task to execute on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window If you don't enable this option, then you must specify previously-registered targets when you register a task with the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. </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="False" position="Named"> <name>Cutoff</name> <description> <para>The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description for the Maintenance Window. We recommend specifying a description to help you organize your Maintenance Windows. </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="False" position="Named"> <name>Duration</name> <description> <para>The duration of the Maintenance Window in hours. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the Maintenance Window. </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="False" position="Named"> <name>Schedule</name> <description> <para>The schedule of the Maintenance Window in the form of a cron or rate expression. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.CreateMaintenanceWindowResponse) 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=New-SSMMaintenanceWindow.html&tocid=New-SSMMaintenanceWindow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> New-SSMMaintenanceWindow -Name "MyMaintenanceWindow" -Duration 4 -Cutoff 1 -AllowUnassociatedTarget $true -Schedule "cron(0 16 ? * TUE *)" mw-03eb53e1ea7383998</code><remarks><para>Description</para><para>-----------</para><para>This example creates a new maintenance window with the specified name that runs at 4 PM on every Tuesday for 4 hours, with a 1 hour cutoff, and that allows unassociated targets.</para><para /><para /></remarks> </example> </examples> </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>New-SSMPatchBaseline</name> <description> <para>Invokes the CreatePatchBaseline operation against Amazon Simple Systems Management.</para> </description> <verb>New</verb> <noun>SSMPatchBaseline</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a patch baseline. </para> </description> <syntax> <syntaxItem> <name>New-SSMPatchBaseline</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovedPatch</name> <description> <para>A list of explicitly approved patches for the baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovedPatchesComplianceLevel</name> <description> <para>Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid compliance severity levels include the following: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED. The default value is UNSPECIFIED. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.PatchComplianceLevel</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A description of the patch baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the patch baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OperatingSystem</name> <description> <para>Defines the operating system the patch baseline applies to. Supported operating systems include WINDOWS, AMAZON_LINUX, UBUNTU and REDHAT_ENTERPRISE_LINUX. The Default value is WINDOWS. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.OperatingSystem</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GlobalFilters_PatchFilter</name> <description> <para>The set of patch filters that make up the group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovalRules_PatchRule</name> <description> <para>The rules that make up the rule group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchRule[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RejectedPatch</name> <description> <para>A list of explicitly rejected patches for the baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovalRules_PatchRule</name> <description> <para>The rules that make up the rule group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchRule[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.PatchRule[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovedPatch</name> <description> <para>A list of explicitly approved patches for the baseline. </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="False" position="Named"> <name>ApprovedPatchesComplianceLevel</name> <description> <para>Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid compliance severity levels include the following: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED. The default value is UNSPECIFIED. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.PatchComplianceLevel</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.PatchComplianceLevel</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. </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="False" position="Named"> <name>Description</name> <description> <para>A description of the patch baseline. </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="False" 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="False" position="Named"> <name>GlobalFilters_PatchFilter</name> <description> <para>The set of patch filters that make up the group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.PatchFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the patch baseline. </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="False" position="Named"> <name>OperatingSystem</name> <description> <para>Defines the operating system the patch baseline applies to. Supported operating systems include WINDOWS, AMAZON_LINUX, UBUNTU and REDHAT_ENTERPRISE_LINUX. The Default value is WINDOWS. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.OperatingSystem</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.OperatingSystem</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RejectedPatch</name> <description> <para>A list of explicitly rejected patches for the baseline. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.CreatePatchBaselineResponse) 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=New-SSMPatchBaseline.html&tocid=New-SSMPatchBaseline</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $rule = New-Object Amazon.SimpleSystemsManagement.Model.PatchRule PS C:\> $rule.ApproveAfterDays = 7 PS C:\> $ruleFilters = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilterGroup PS C:\> $patchFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter PS C:\> $severityFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter PS C:\> $severityFilter.Key="MSRC_SEVERITY" PS C:\> $severityFilter.Values.Add("Critical") PS C:\> $severityFilter.Values.Add("Important") PS C:\> $severityFilter.Values.Add("Moderate") PS C:\> $classificationFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter PS C:\> $classificationFilter.Key = "CLASSIFICATION" PS C:\> $classificationFilter.Values.Add( "SecurityUpdates" ) PS C:\> $classificationFilter.Values.Add( "Updates" ) PS C:\> $classificationFilter.Values.Add( "UpdateRollups" ) PS C:\> $classificationFilter.Values.Add( "CriticalUpdates" ) PS C:\> $ruleFilters.PatchFilters.Add($severityFilter) PS C:\> $ruleFilters.PatchFilters.Add($classificationFilter) PS C:\> $rule.PatchFilterGroup = $ruleFilters PS C:\> New-SSMPatchBaseline -Name "Production-Baseline" -Description "Baseline containing all updates approved for production systems" -ApprovalRules_PatchRule $rule pb-03da896ca3b68b639</code><remarks><para>Description</para><para>-----------</para><para>This example creates a patch baseline that approves patches for a production environment seven days after they are released by Microsoft.</para><para /><para /></remarks> </example> </examples> </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>New-SSMResourceDataSync</name> <description> <para>Invokes the CreateResourceDataSync operation against Amazon Simple Systems Management.</para> </description> <verb>New</verb> <noun>SSMResourceDataSync</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the <a href="API_ListResourceDataSync.html">ListResourceDataSync</a> operation. By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync">Configuring Resource Data Sync for Inventory</a>. </para> </description> <syntax> <syntaxItem> <name>New-SSMResourceDataSync</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SyncName</name> <description> <para>A name for the configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Destination_AWSKMSKeyARN</name> <description> <para>The ARN of an encryption key for a destination in Amazon S3. Must belong to the same region as the destination Amazon S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Destination_BucketName</name> <description> <para>The name of the Amazon S3 bucket where the aggregated data is stored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Destination_Prefix</name> <description> <para>An Amazon S3 prefix for the bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Destination_Region</name> <description> <para>The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Destination_SyncFormat</name> <description> <para>A supported sync format. The following format is currently supported: JsonSerDe </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ResourceDataSyncS3Format</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SyncName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SyncName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>S3Destination_AWSKMSKeyARN</name> <description> <para>The ARN of an encryption key for a destination in Amazon S3. Must belong to the same region as the destination Amazon S3 bucket. </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="False" position="Named"> <name>S3Destination_BucketName</name> <description> <para>The name of the Amazon S3 bucket where the aggregated data is stored. </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="False" position="Named"> <name>S3Destination_Prefix</name> <description> <para>An Amazon S3 prefix for the bucket. </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="False" position="Named"> <name>S3Destination_Region</name> <description> <para>The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync. </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="False" position="Named"> <name>S3Destination_SyncFormat</name> <description> <para>A supported sync format. The following format is currently supported: JsonSerDe </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ResourceDataSyncS3Format</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.ResourceDataSyncS3Format</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SyncName</name> <description> <para>A name for the configuration. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SyncName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.CreateResourceDataSyncResponse) 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=New-SSMResourceDataSync.html&tocid=New-SSMResourceDataSync</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Register-SSMDefaultPatchBaseline</name> <description> <para>Invokes the RegisterDefaultPatchBaseline operation against Amazon Simple Systems Management.</para> </description> <verb>Register</verb> <noun>SSMDefaultPatchBaseline</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Defines the default patch baseline. </para> </description> <syntax> <syntaxItem> <name>Register-SSMDefaultPatchBaseline</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline that should be the default patch baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline that should be the default patch baseline. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.RegisterDefaultPatchBaselineResponse) 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=Register-SSMDefaultPatchBaseline.html&tocid=Register-SSMDefaultPatchBaseline</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Register-SSMDefaultPatchBaseline -BaselineId "pb-03da896ca3b68b639" pb-03da896ca3b68b639</code><remarks><para>Description</para><para>-----------</para><para>This example registers a patch baseline as the default patch baseline.</para><para /><para /></remarks> </example> </examples> </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>Register-SSMPatchBaselineForPatchGroup</name> <description> <para>Invokes the RegisterPatchBaselineForPatchGroup operation against Amazon Simple Systems Management.</para> </description> <verb>Register</verb> <noun>SSMPatchBaselineForPatchGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers a patch baseline for a patch group. </para> </description> <syntax> <syntaxItem> <name>Register-SSMPatchBaselineForPatchGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to register the patch group with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PatchGroup</name> <description> <para>The name of the patch group that should be registered with the patch baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to register the patch group with. </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="False" 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>PatchGroup</name> <description> <para>The name of the patch group that should be registered with the patch baseline. </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.SimpleSystemsManagement.Model.RegisterPatchBaselineForPatchGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.RegisterPatchBaselineForPatchGroupResponse 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=Register-SSMPatchBaselineForPatchGroup.html&tocid=Register-SSMPatchBaselineForPatchGroup</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Register-SSMPatchBaselineForPatchGroup -BaselineId "pb-03da896ca3b68b639" -PatchGroup "Production" BaselineId PatchGroup ---------- ---------- pb-03da896ca3b68b639 Production</code><remarks><para>Description</para><para>-----------</para><para>This example registers a patch baseline for a patch group.</para><para /><para /></remarks> </example> </examples> </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>Register-SSMTargetWithMaintenanceWindow</name> <description> <para>Invokes the RegisterTargetWithMaintenanceWindow operation against Amazon Simple Systems Management.</para> </description> <verb>Register</verb> <noun>SSMTargetWithMaintenanceWindow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers a target with a Maintenance Window. </para> </description> <syntax> <syntaxItem> <name>Register-SSMTargetWithMaintenanceWindow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window the target should be registered with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description for the target. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>An optional name for the target. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OwnerInformation</name> <description> <para>User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of target being registered with the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.MaintenanceWindowResourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>The targets (either instances or tags). Instances are specified using Key=instanceids,Values=&lt;instanceid1&gt;,&lt;instanceid2&gt;. Tags are specified using Key=&lt;tag name&gt;,Values=&lt;tag value&gt;. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. </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="False" position="Named"> <name>Description</name> <description> <para>An optional description for the target. </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="False" 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>Name</name> <description> <para>An optional name for the target. </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="False" position="Named"> <name>OwnerInformation</name> <description> <para>User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of target being registered with the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.MaintenanceWindowResourceType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.MaintenanceWindowResourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>The targets (either instances or tags). Instances are specified using Key=instanceids,Values=&lt;instanceid1&gt;,&lt;instanceid2&gt;. Tags are specified using Key=&lt;tag name&gt;,Values=&lt;tag value&gt;. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Target[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window the target should be registered with. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.RegisterTargetWithMaintenanceWindowResponse) 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=Register-SSMTargetWithMaintenanceWindow.html&tocid=Register-SSMTargetWithMaintenanceWindow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862")} PS C:\> Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE" d8e47760-23ed-46a5-9f28-927337725398</code><remarks><para>Description</para><para>-----------</para><para>This example registers an instance with a maintenance window.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862","i-0cb2b964d3e14fd9f")} PS C:\> Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE" 6ab5c208-9fc4-4697-84b7-b02a6cc25f7d</code><remarks><para>Description</para><para>-----------</para><para>This example registers multiple instances with a maintenance window.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\> $option1 = @{Key="tag:Environment";Values=@("Production")} PS C:\> Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Production Web Servers" -ResourceType "INSTANCE" 2994977e-aefb-4a71-beac-df620352f184</code><remarks><para>Description</para><para>-----------</para><para>This example registers an instance with a maintenance window using EC2 tags.</para><para /><para /></remarks> </example> </examples> </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>Register-SSMTaskWithMaintenanceWindow</name> <description> <para>Invokes the RegisterTaskWithMaintenanceWindow operation against Amazon Simple Systems Management.</para> </description> <verb>Register</verb> <noun>SSMTaskWithMaintenanceWindow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds a new task to a Maintenance Window. </para> </description> <syntax> <syntaxItem> <name>Register-SSMTaskWithMaintenanceWindow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TaskArn</name> <description> <para>The ARN of the task to execute </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Lambda_ClientContext</name> <description> <para>Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_Comment</name> <description> <para>Information about the command(s) to execute. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description for the task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_DocumentHash</name> <description> <para>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_DocumentHashType</name> <description> <para>SHA-256 or SHA-1. SHA-1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentHashType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Automation_DocumentVersion</name> <description> <para>The version of an Automation document to use during task execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StepFunctions_Input</name> <description> <para>The inputs for the STEP_FUNCTION task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxConcurrency</name> <description> <para>The maximum number of targets this task can be run for in parallel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxError</name> <description> <para>The maximum number of errors allowed before this task stops being scheduled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>An optional name for the task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StepFunctions_Name</name> <description> <para>The name of the STEP_FUNCTION task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationArn</name> <description> <para>An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationEvent</name> <description> <para>The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html">Setting Up Events and Notifications</a> in the <i>Amazon EC2 Systems Manager User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationType</name> <description> <para>Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.NotificationType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_OutputS3BucketName</name> <description> <para>The name of the Amazon S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_OutputS3KeyPrefix</name> <description> <para>The Amazon S3 bucket subfolder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Automation_Parameter</name> <description> <para>The parameters for the AUTOMATION task. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_Parameter</name> <description> <para>The parameters for the RUN_COMMAND task execution. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Lambda_Payload</name> <description> <para>JSON to provide to your Lambda function as input. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Priority</name> <description> <para>The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Lambda_Qualifier</name> <description> <para>(Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingInfo_S3BucketName</name> <description> <para>The name of an Amazon S3 bucket where execution logs are stored . </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingInfo_S3KeyPrefix</name> <description> <para>(Optional) The Amazon S3 bucket subfolder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingInfo_S3Region</name> <description> <para>The region where the Amazon S3 bucket is located. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The role that should be assumed when executing the task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_ServiceRoleArn</name> <description> <para>The IAM service role to assume during task execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>The targets (either instances or tags). Instances are specified using Key=instanceids,Values=&lt;instanceid1&gt;,&lt;instanceid2&gt;. Tags are specified using Key=&lt;tag name&gt;,Values=&lt;tag value&gt;. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TaskParameter</name> <description> <para>The parameters that should be passed to the task when it is executed. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TaskType</name> <description> <para>The type of task being registered. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.MaintenanceWindowTaskType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_TimeoutSecond</name> <description> <para>If this time is reached and the command has not already started executing, it doesn not execute. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The id of the Maintenance Window the task should be added to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Automation_DocumentVersion</name> <description> <para>The version of an Automation document to use during task execution. </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="False" position="Named"> <name>Automation_Parameter</name> <description> <para>The parameters for the AUTOMATION task. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. </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="False" position="Named"> <name>Description</name> <description> <para>An optional description for the task. </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="False" 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="False" position="Named"> <name>Lambda_ClientContext</name> <description> <para>Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. </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="False" position="Named"> <name>Lambda_Payload</name> <description> <para>JSON to provide to your Lambda function as input. </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="False" position="Named"> <name>Lambda_Qualifier</name> <description> <para>(Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points. </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="False" position="Named"> <name>LoggingInfo_S3BucketName</name> <description> <para>The name of an Amazon S3 bucket where execution logs are stored . </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="False" position="Named"> <name>LoggingInfo_S3KeyPrefix</name> <description> <para>(Optional) The Amazon S3 bucket subfolder. </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="False" position="Named"> <name>LoggingInfo_S3Region</name> <description> <para>The region where the Amazon S3 bucket is located. </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="False" position="Named"> <name>MaxConcurrency</name> <description> <para>The maximum number of targets this task can be run for in parallel. </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="False" position="Named"> <name>MaxError</name> <description> <para>The maximum number of errors allowed before this task stops being scheduled. </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>Name</name> <description> <para>An optional name for the task. </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="False" position="Named"> <name>NotificationConfig_NotificationArn</name> <description> <para>An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic. </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="False" position="Named"> <name>NotificationConfig_NotificationEvent</name> <description> <para>The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html">Setting Up Events and Notifications</a> in the <i>Amazon EC2 Systems Manager User Guide</i>. </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="False" position="Named"> <name>NotificationConfig_NotificationType</name> <description> <para>Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.NotificationType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.NotificationType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Priority</name> <description> <para>The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_Comment</name> <description> <para>Information about the command(s) to execute. </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="False" position="Named"> <name>RunCommand_DocumentHash</name> <description> <para>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated. </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="False" position="Named"> <name>RunCommand_DocumentHashType</name> <description> <para>SHA-256 or SHA-1. SHA-1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentHashType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.DocumentHashType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_OutputS3BucketName</name> <description> <para>The name of the Amazon S3 bucket. </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="False" position="Named"> <name>RunCommand_OutputS3KeyPrefix</name> <description> <para>The Amazon S3 bucket subfolder. </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="False" position="Named"> <name>RunCommand_Parameter</name> <description> <para>The parameters for the RUN_COMMAND task execution. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_ServiceRoleArn</name> <description> <para>The IAM service role to assume during task execution. </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="False" position="Named"> <name>RunCommand_TimeoutSecond</name> <description> <para>If this time is reached and the command has not already started executing, it doesn not execute. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The role that should be assumed when executing the task. </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="False" position="Named"> <name>StepFunctions_Input</name> <description> <para>The inputs for the STEP_FUNCTION task. </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="False" position="Named"> <name>StepFunctions_Name</name> <description> <para>The name of the STEP_FUNCTION task. </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="False" position="Named"> <name>Target</name> <description> <para>The targets (either instances or tags). Instances are specified using Key=instanceids,Values=&lt;instanceid1&gt;,&lt;instanceid2&gt;. Tags are specified using Key=&lt;tag name&gt;,Values=&lt;tag value&gt;. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Target[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TaskArn</name> <description> <para>The ARN of the task to execute </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="False" position="Named"> <name>TaskParameter</name> <description> <para>The parameters that should be passed to the task when it is executed. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TaskType</name> <description> <para>The type of task being registered. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.MaintenanceWindowTaskType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.MaintenanceWindowTaskType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The id of the Maintenance Window the task should be added to. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.RegisterTaskWithMaintenanceWindowResponse) 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=Register-SSMTaskWithMaintenanceWindow.html&tocid=Register-SSMTaskWithMaintenanceWindow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $parameters = @{} PS C:\> $parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression PS C:\> $parameterValues.Values = @("Install") PS C:\> $parameters.Add("Operation", $parameterValues) PS C:\> Register-SSMTaskWithMaintenanceWindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="InstanceIds";Values="i-0000293ffd8c57862" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters f34a2c47-ddfd-4c85-a88d-72366b69af1b</code><remarks><para>Description</para><para>-----------</para><para>This example registers a task with a maintenance window using an instance ID. The output is the Task ID.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> $parameters = @{} PS C:\> $parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression PS C:\> $parameterValues.Values = @("Install") PS C:\> $parameters.Add("Operation", $parameterValues) PS C:\> register-ssmtaskwithmaintenancewindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="WindowTargetIds";Values="350d44e6-28cc-44e2-951f-4b2c985838f6" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters f34a2c47-ddfd-4c85-a88d-72366b69af1b</code><remarks><para>Description</para><para>-----------</para><para>This example registers a task with a maintenance window using a target ID. The output is the Task ID.</para><para /><para /></remarks> </example> </examples> </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-SSMActivation</name> <description> <para>Invokes the DeleteActivation operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMActivation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMActivation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivationId</name> <description> <para>The ID of the activation that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ActivationId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ActivationId</name> <description> <para>The ID of the activation that you want to delete. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ActivationId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ActivationId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.DeleteActivationResponse) 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-SSMActivation.html&tocid=Remove-SSMActivation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Remove-SSMActivation -ActivationId "08e51e79-1e36-446c-8e63-9458569c1363"</code><remarks><para>Description</para><para>-----------</para><para>This example deletes an activation. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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-SSMAssociation</name> <description> <para>Invokes the DeleteAssociation operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMAssociation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMAssociation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID of the instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AssociationId</name> <description> <para>The association ID that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the Systems Manager document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AssociationId</name> <description> <para>The association ID that you want to delete. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID of the instance. </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>Name</name> <description> <para>The name of the Systems Manager document. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.DeleteAssociationResponse) 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-SSMAssociation.html&tocid=Remove-SSMAssociation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Remove-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"</code><remarks><para>Description</para><para>-----------</para><para>This example deletes the association between an instance and a document. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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-SSMDocument</name> <description> <para>Invokes the DeleteDocument operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMDocument</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use <a>DeleteAssociation</a> to disassociate all instances that are associated with the document. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMDocument</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the document. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Name parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.DeleteDocumentResponse) 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-SSMDocument.html&tocid=Remove-SSMDocument</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Remove-SSMDocument -Name "RunShellScript"</code><remarks><para>Description</para><para>-----------</para><para>This example deletes a document. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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-SSMMaintenanceWindow</name> <description> <para>Invokes the DeleteMaintenanceWindow operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMMaintenanceWindow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a Maintenance Window. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMMaintenanceWindow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window to delete. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.DeleteMaintenanceWindowResponse) 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=Remove-SSMMaintenanceWindow.html&tocid=Remove-SSMMaintenanceWindow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Remove-SSMMaintenanceWindow -WindowId "mw-06d59c1a07c022145" mw-06d59c1a07c022145</code><remarks><para>Description</para><para>-----------</para><para>This example removes a maintenance window.</para><para /><para /></remarks> </example> </examples> </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-SSMParameter</name> <description> <para>Invokes the DeleteParameter operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete a parameter from the system. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the parameter to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the parameter to delete. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Name parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.DeleteParameterResponse) 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-SSMParameter.html&tocid=Remove-SSMParameter</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Remove-SSMParameter -Name "helloWorld"</code><remarks><para>Description</para><para>-----------</para><para>This example deletes a parameter. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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-SSMParameterCollection</name> <description> <para>Invokes the DeleteParameters operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMParameterCollection</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMParameterCollection</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The names of the parameters to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The names of the parameters to delete. </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.SimpleSystemsManagement.Model.DeleteParametersResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.DeleteParametersResponse 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=Remove-SSMParameterCollection.html&tocid=Remove-SSMParameterCollection</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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-SSMPatchBaseline</name> <description> <para>Invokes the DeletePatchBaseline operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMPatchBaseline</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a patch baseline. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMPatchBaseline</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to delete. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.DeletePatchBaselineResponse) 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=Remove-SSMPatchBaseline.html&tocid=Remove-SSMPatchBaseline</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Remove-SSMPatchBaseline -BaselineId "pb-045f10b4f382baeda" pb-045f10b4f382baeda</code><remarks><para>Description</para><para>-----------</para><para>This example deletes a patch baseline.</para><para /><para /></remarks> </example> </examples> </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-SSMResourceDataSync</name> <description> <para>Invokes the DeleteResourceDataSync operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMResourceDataSync</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMResourceDataSync</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SyncName</name> <description> <para>The name of the configuration to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SyncName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SyncName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>SyncName</name> <description> <para>The name of the configuration to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SyncName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.DeleteResourceDataSyncResponse) 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-SSMResourceDataSync.html&tocid=Remove-SSMResourceDataSync</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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-SSMResourceTag</name> <description> <para>Invokes the RemoveTagsFromResource operation against Amazon Simple Systems Management.</para> </description> <verb>Remove</verb> <noun>SSMResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes all tags from the specified resource. </para> </description> <syntax> <syntaxItem> <name>Remove-SSMResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceId</name> <description> <para>The resource ID for which you want to remove tags. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of resource of which you want to remove a tag. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ResourceTypeForTagging</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>Tag keys that you want to remove from the specified resource. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>ResourceId</name> <description> <para>The resource ID for which you want to remove tags. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of resource of which you want to remove a tag. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ResourceTypeForTagging</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.ResourceTypeForTagging</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>Tag keys that you want to remove from the specified resource. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.RemoveTagsFromResourceResponse) 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-SSMResourceTag.html&tocid=Remove-SSMResourceTag</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Remove-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -TagKey "Production"</code><remarks><para>Description</para><para>-----------</para><para>This example removes a tag from a maintenance window. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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-SSMAutomationSignal</name> <description> <para>Invokes the SendAutomationSignal operation against Amazon Simple Systems Management.</para> </description> <verb>Send</verb> <noun>SSMAutomationSignal</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sends a signal to an Automation execution to change the current behavior or status of the execution. </para> </description> <syntax> <syntaxItem> <name>Send-SSMAutomationSignal</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AutomationExecutionId</name> <description> <para>The unique identifier for an existing Automation execution that you want to send the signal to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Payload</name> <description> <para>The data sent with the signal. The data schema depends on the type of signal used in the request. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SignalType</name> <description> <para>The type of signal. Valid signal types include the following: Approve and Reject </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.SignalType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AutomationExecutionId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AutomationExecutionId</name> <description> <para>The unique identifier for an existing Automation execution that you want to send the signal to. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AutomationExecutionId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Payload</name> <description> <para>The data sent with the signal. The data schema depends on the type of signal used in the request. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SignalType</name> <description> <para>The type of signal. Valid signal types include the following: Approve and Reject </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.SignalType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.SignalType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AutomationExecutionId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.SendAutomationSignalResponse) 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-SSMAutomationSignal.html&tocid=Send-SSMAutomationSignal</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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-SSMCommand</name> <description> <para>Invokes the SendCommand operation against Amazon Simple Systems Management.</para> </description> <verb>Send</verb> <noun>SSMCommand</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Executes commands on one or more managed instances. </para> </description> <syntax> <syntaxItem> <name>Send-SSMCommand</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>User-specified information about the command, such as a brief description of what the command should do. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentHash</name> <description> <para>The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentHashType</name> <description> <para>Sha256 or Sha1. Sha1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentHashType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentName</name> <description> <para>Required. The name of the Systems Manager document to execute. This can be a public document or a custom document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InstanceId</name> <description> <para>The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Sending Commands to a Fleet</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxConcurrency</name> <description> <para>(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-velocity.html">Using Concurrency Controls</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxError</name> <description> <para>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-maxerrors.html">Using Error Controls</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationArn</name> <description> <para>An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationEvent</name> <description> <para>The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html">Setting Up Events and Notifications</a> in the <i>Amazon EC2 Systems Manager User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationType</name> <description> <para>Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.NotificationType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputS3BucketName</name> <description> <para>The name of the S3 bucket where command execution responses should be stored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputS3KeyPrefix</name> <description> <para>The directory structure within the S3 bucket where the responses should be stored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputS3Region</name> <description> <para>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameter</name> <description> <para>The required and optional parameters specified in the document being executed. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The IAM role that Systems Manager uses to send notifications. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Sending Commands to a Fleet</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeoutSecond</name> <description> <para>If this time is reached and the command has not already started executing, it will not execute. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>User-specified information about the command, such as a brief description of what the command should do. </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="False" position="Named"> <name>DocumentHash</name> <description> <para>The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated. </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="False" position="Named"> <name>DocumentHashType</name> <description> <para>Sha256 or Sha1. Sha1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentHashType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.DocumentHashType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentName</name> <description> <para>Required. The name of the Systems Manager document to execute. This can be a public document or a custom document. </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="False" 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>InstanceId</name> <description> <para>The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Sending Commands to a Fleet</a>. </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="False" position="Named"> <name>MaxConcurrency</name> <description> <para>(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-velocity.html">Using Concurrency Controls</a>. </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="False" position="Named"> <name>MaxError</name> <description> <para>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-maxerrors.html">Using Error Controls</a>. </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="False" position="Named"> <name>NotificationConfig_NotificationArn</name> <description> <para>An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic. </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="False" position="Named"> <name>NotificationConfig_NotificationEvent</name> <description> <para>The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html">Setting Up Events and Notifications</a> in the <i>Amazon EC2 Systems Manager User Guide</i>. </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="False" position="Named"> <name>NotificationConfig_NotificationType</name> <description> <para>Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.NotificationType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.NotificationType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputS3BucketName</name> <description> <para>The name of the S3 bucket where command execution responses should be stored. </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="False" position="Named"> <name>OutputS3KeyPrefix</name> <description> <para>The directory structure within the S3 bucket where the responses should be stored. </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="False" position="Named"> <name>OutputS3Region</name> <description> <para>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. </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="False" position="Named"> <name>Parameter</name> <description> <para>The required and optional parameters specified in the document being executed. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The IAM role that Systems Manager uses to send notifications. </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="False" position="Named"> <name>Target</name> <description> <para>(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Sending Commands to a Fleet</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Target[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TimeoutSecond</name> <description> <para>If this time is reached and the command has not already started executing, it will not execute. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Command</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Command object. The service call response (type Amazon.SimpleSystemsManagement.Model.SendCommandResponse) 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=Send-SSMCommand.html&tocid=Send-SSMCommand</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Send-SSMCommand -DocumentName "AWS-RunPowerShellScript" -Parameter @{commands = "echo helloWorld"} -Target @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")} CommandId : d8d190fc-32c1-4d65-a0df-ff5ff3965524 Comment : CompletedCount : 0 DocumentName : AWS-RunPowerShellScript ErrorCount : 0 ExpiresAfter : 3/7/2017 10:48:37 PM InstanceIds : {} MaxConcurrency : 50 MaxErrors : 0 NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig OutputS3BucketName : OutputS3KeyPrefix : OutputS3Region : Parameters : {[commands, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]} RequestedDateTime : 3/7/2017 9:48:37 PM ServiceRole : Status : Pending StatusDetails : Pending TargetCount : 0 Targets : {instanceids}</code><remarks><para>Description</para><para>-----------</para><para>This example runs an echo command on a target instance.</para><para /><para /></remarks> </example> </examples> </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>Start-SSMAutomationExecution</name> <description> <para>Invokes the StartAutomationExecution operation against Amazon Simple Systems Management.</para> </description> <verb>Start</verb> <noun>SSMAutomationExecution</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Initiates execution of an Automation document. </para> </description> <syntax> <syntaxItem> <name>Start-SSMAutomationExecution</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DocumentName</name> <description> <para>The name of the Automation document to use for this execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The version of the Automation document to use for this execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameter</name> <description> <para>A key-value map of execution parameters, which match the declared parameters in the Automation document. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClientToken</name> <description> <para>User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused. </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 (ByValue, )" position="1"> <name>DocumentName</name> <description> <para>The name of the Automation document to use for this execution. </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="False" position="Named"> <name>DocumentVersion</name> <description> <para>The version of the Automation document to use for this execution. </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="False" 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="False" position="Named"> <name>Parameter</name> <description> <para>A key-value map of execution parameters, which match the declared parameters in the Automation document. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleSystemsManagement.Model.StartAutomationExecutionResponse) 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=Start-SSMAutomationExecution.html&tocid=Start-SSMAutomationExecution</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Start-SSMAutomationExecution -DocumentName AWS-UpdateLinuxAmi -Parameter @{'AutomationAssumeRole'='arn:aws:iam::123456789012:role/SSMAutomationRole';'SourceAmiId'='ami-f173cc91';'InstanceIamRole'='EC2InstanceRole'} 3a532a4f-0382-11e7-9df7-6f11185f6dd1</code><remarks><para>Description</para><para>-----------</para><para>This example runs a document specifying an Automation role, an AMI source ID, and an Amazon EC2 instance role.</para><para /><para /></remarks> </example> </examples> </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>Stop-SSMAutomationExecution</name> <description> <para>Invokes the StopAutomationExecution operation against Amazon Simple Systems Management.</para> </description> <verb>Stop</verb> <noun>SSMAutomationExecution</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Stop an Automation that is currently executing. </para> </description> <syntax> <syntaxItem> <name>Stop-SSMAutomationExecution</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AutomationExecutionId</name> <description> <para>The execution ID of the Automation to stop. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AutomationExecutionId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AutomationExecutionId</name> <description> <para>The execution ID of the Automation to stop. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AutomationExecutionId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AutomationExecutionId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.StopAutomationExecutionResponse) 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=Stop-SSMAutomationExecution.html&tocid=Stop-SSMAutomationExecution</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Stop-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"</code><remarks><para>Description</para><para>-----------</para><para>This example stops an Automation Execution. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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>Stop-SSMCommand</name> <description> <para>Invokes the CancelCommand operation against Amazon Simple Systems Management.</para> </description> <verb>Stop</verb> <noun>SSMCommand</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </para> </description> <syntax> <syntaxItem> <name>Stop-SSMCommand</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CommandId</name> <description> <para>The ID of the command you want to cancel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InstanceId</name> <description> <para>(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CommandId</name> <description> <para>The ID of the command you want to cancel. </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="False" 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>InstanceId</name> <description> <para>(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.SimpleSystemsManagement.Model.CancelCommandResponse) 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=Stop-SSMCommand.html&tocid=Stop-SSMCommand</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Stop-SSMCommand -CommandId "9ded293e-e792-4440-8e3e-7b8ec5feaa38"</code><remarks><para>Description</para><para>-----------</para><para>This example attempts to cancel a command. There is no output if the operation succeeds.</para><para /><para /></remarks> </example> </examples> </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>Unregister-SSMManagedInstance</name> <description> <para>Invokes the DeregisterManagedInstance operation against Amazon Simple Systems Management.</para> </description> <verb>Unregister</verb> <noun>SSMManagedInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling the SSM Agent first. </para> </description> <syntax> <syntaxItem> <name>Unregister-SSMManagedInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID assigned to the managed instance when you registered it using the activation process. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID assigned to the managed instance when you registered it using the activation process. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.DeregisterManagedInstanceResponse) 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=Unregister-SSMManagedInstance.html&tocid=Unregister-SSMManagedInstance</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Unregister-SSMManagedInstance -InstanceId "mi-08ab247cdf1046573"</code><remarks><para>Description</para><para>-----------</para><para>This example deregisters a managed instance. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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>Unregister-SSMPatchBaselineForPatchGroup</name> <description> <para>Invokes the DeregisterPatchBaselineForPatchGroup operation against Amazon Simple Systems Management.</para> </description> <verb>Unregister</verb> <noun>SSMPatchBaselineForPatchGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes a patch group from a patch baseline. </para> </description> <syntax> <syntaxItem> <name>Unregister-SSMPatchBaselineForPatchGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PatchGroup</name> <description> <para>The name of the patch group that should be deregistered from the patch baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to deregister the patch group from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to deregister the patch group from. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>PatchGroup</name> <description> <para>The name of the patch group that should be deregistered from the patch baseline. </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.SimpleSystemsManagement.Model.DeregisterPatchBaselineForPatchGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.DeregisterPatchBaselineForPatchGroupResponse 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=Unregister-SSMPatchBaselineForPatchGroup.html&tocid=Unregister-SSMPatchBaselineForPatchGroup</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Unregister-SSMPatchBaselineForPatchGroup -BaselineId "pb-045f10b4f382baeda" -PatchGroup "Production" BaselineId PatchGroup ---------- ---------- pb-045f10b4f382baeda Production</code><remarks><para>Description</para><para>-----------</para><para>This example deregisters a patch group from a patch baseline.</para><para /><para /></remarks> </example> </examples> </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>Unregister-SSMTargetFromMaintenanceWindow</name> <description> <para>Invokes the DeregisterTargetFromMaintenanceWindow operation against Amazon Simple Systems Management.</para> </description> <verb>Unregister</verb> <noun>SSMTargetFromMaintenanceWindow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes a target from a Maintenance Window. </para> </description> <syntax> <syntaxItem> <name>Unregister-SSMTargetFromMaintenanceWindow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowTargetId</name> <description> <para>The ID of the target definition to remove. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Safe</name> <description> <para>The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window the target should be removed from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Safe</name> <description> <para>The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window the target should be removed from. </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 (ByValue, ByPropertyName)" position="1"> <name>WindowTargetId</name> <description> <para>The ID of the target definition to remove. </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.SimpleSystemsManagement.Model.DeregisterTargetFromMaintenanceWindowResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.DeregisterTargetFromMaintenanceWindowResponse 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=Unregister-SSMTargetFromMaintenanceWindow.html&tocid=Unregister-SSMTargetFromMaintenanceWindow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Unregister-SSMTargetFromMaintenanceWindow -WindowTargetId "6ab5c208-9fc4-4697-84b7-b02a6cc25f7d" -WindowId "mw-06cf17cbefcb4bf4f" WindowId WindowTargetId -------- -------------- mw-06cf17cbefcb4bf4f 6ab5c208-9fc4-4697-84b7-b02a6cc25f7d</code><remarks><para>Description</para><para>-----------</para><para>This example removes a target from a maintenance window.</para><para /><para /></remarks> </example> </examples> </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>Unregister-SSMTaskFromMaintenanceWindow</name> <description> <para>Invokes the DeregisterTaskFromMaintenanceWindow operation against Amazon Simple Systems Management.</para> </description> <verb>Unregister</verb> <noun>SSMTaskFromMaintenanceWindow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes a task from a Maintenance Window. </para> </description> <syntax> <syntaxItem> <name>Unregister-SSMTaskFromMaintenanceWindow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowTaskId</name> <description> <para>The ID of the task to remove from the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window the task should be removed from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>WindowId</name> <description> <para>The ID of the Maintenance Window the task should be removed from. </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 (ByValue, ByPropertyName)" position="1"> <name>WindowTaskId</name> <description> <para>The ID of the task to remove from the Maintenance Window. </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.SimpleSystemsManagement.Model.DeregisterTaskFromMaintenanceWindowResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.DeregisterTaskFromMaintenanceWindowResponse 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=Unregister-SSMTaskFromMaintenanceWindow.html&tocid=Unregister-SSMTaskFromMaintenanceWindow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Unregister-SSMTaskFromMaintenanceWindow -WindowTaskId "f34a2c47-ddfd-4c85-a88d-72366b69af1b" -WindowId "mw-03a342e62c96d31b0" WindowId WindowTaskId -------- ------------ mw-03a342e62c96d31b0 f34a2c47-ddfd-4c85-a88d-72366b69af1b</code><remarks><para>Description</para><para>-----------</para><para>This example removes a task from a maintenance window.</para><para /><para /></remarks> </example> </examples> </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>Update-SSMAssociation</name> <description> <para>Invokes the UpdateAssociation operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMAssociation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. </para> </description> <syntax> <syntaxItem> <name>Update-SSMAssociation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AssociationId</name> <description> <para>The ID of the association you want to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationName</name> <description> <para>The name of the association that you want to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationVersion</name> <description> <para>This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify <code>$LATEST</code>, or omit this parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The document version you want update for the association. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the association document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Location_OutputS3BucketName</name> <description> <para>The name of the Amazon S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Location_OutputS3KeyPrefix</name> <description> <para>The Amazon S3 bucket subfolder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Location_OutputS3Region</name> <description> <para>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameter</name> <description> <para>The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}} </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ScheduleExpression</name> <description> <para>The cron expression used to schedule the association that you want to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>The targets of the association. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AssociationId</name> <description> <para>The ID of the association you want to update. </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="False" position="Named"> <name>AssociationName</name> <description> <para>The name of the association that you want to update. </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="False" position="Named"> <name>AssociationVersion</name> <description> <para>This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify <code>$LATEST</code>, or omit this parameter. </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="False" position="Named"> <name>DocumentVersion</name> <description> <para>The document version you want update for the association. </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="False" 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>Name</name> <description> <para>The name of the association document. </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="False" position="Named"> <name>Parameter</name> <description> <para>The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}} </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Location_OutputS3BucketName</name> <description> <para>The name of the Amazon S3 bucket. </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="False" position="Named"> <name>S3Location_OutputS3KeyPrefix</name> <description> <para>The Amazon S3 bucket subfolder. </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="False" position="Named"> <name>S3Location_OutputS3Region</name> <description> <para>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region. </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="False" position="Named"> <name>ScheduleExpression</name> <description> <para>The cron expression used to schedule the association that you want to update. </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="False" position="Named"> <name>Target</name> <description> <para>The targets of the association. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Target[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.SimpleSystemsManagement.Model.AssociationDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a AssociationDescription object. The service call response (type Amazon.SimpleSystemsManagement.Model.UpdateAssociationResponse) 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=Update-SSMAssociation.html&tocid=Update-SSMAssociation</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Update-SSMAssociation -AssociationId "93285663-92df-44cb-9f26-2292d4ecc439" -DocumentVersion "1" Name : AWS-UpdateSSMAgent InstanceId : Date : 3/1/2017 6:22:21 PM Status.Name : Status.Date : Status.Message : Status.AdditionalInfo :</code><remarks><para>Description</para><para>-----------</para><para>This example updates an association with a new document version.</para><para /><para /></remarks> </example> </examples> </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>Update-SSMAssociationStatus</name> <description> <para>Invokes the UpdateAssociationStatus operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMAssociationStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the status of the Systems Manager document associated with the specified instance. </para> </description> <syntax> <syntaxItem> <name>Update-SSMAssociationStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID of the instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationStatus_AdditionalInfo</name> <description> <para>A user-defined string. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationStatus_Date</name> <description> <para>The date when the status changed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationStatus_Message</name> <description> <para>The reason for the status. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationStatus_Name</name> <description> <para>The status. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.AssociationStatusName</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the Systems Manager document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationStatus_AdditionalInfo</name> <description> <para>A user-defined string. </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="False" position="Named"> <name>AssociationStatus_Date</name> <description> <para>The date when the status changed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociationStatus_Message</name> <description> <para>The reason for the status. </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="False" position="Named"> <name>AssociationStatus_Name</name> <description> <para>The status. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.AssociationStatusName</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.AssociationStatusName</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID of the instance. </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>Name</name> <description> <para>The name of the Systems Manager document. </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.SimpleSystemsManagement.Model.AssociationDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a AssociationDescription object. The service call response (type Amazon.SimpleSystemsManagement.Model.UpdateAssociationStatusResponse) 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=Update-SSMAssociationStatus.html&tocid=Update-SSMAssociationStatus</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Update-SSMAssociationStatus -Name "AWS-UpdateSSMAgent" -InstanceId "i-0000293ffd8c57862" -AssociationStatus_Date "2015-02-20T08:31:11Z" -AssociationStatus_Name "Pending" -AssociationStatus_Message "temporary_status_change" -AssociationStatus_AdditionalInfo "Additional-Config-Needed" Name : AWS-UpdateSSMAgent InstanceId : i-0000293ffd8c57862 Date : 2/23/2017 6:55:22 PM Status.Name : Pending Status.Date : 2/20/2015 8:31:11 AM Status.Message : temporary_status_change Status.AdditionalInfo : Additional-Config-Needed</code><remarks><para>Description</para><para>-----------</para><para>This example updates the association status of the association between an instance and a configuration document.</para><para /><para /></remarks> </example> </examples> </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>Update-SSMDocument</name> <description> <para>Invokes the UpdateDocument operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMDocument</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The document you want to update. </para> </description> <syntax> <syntaxItem> <name>Update-SSMDocument</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Content</name> <description> <para>The content in a document that you want to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The version of the document that you want to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the document that you want to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Content</name> <description> <para>The content in a document that you want to update. </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="False" position="Named"> <name>DocumentVersion</name> <description> <para>The version of the document that you want to update. </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="False" 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>Name</name> <description> <para>The name of the document that you want to update. </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.SimpleSystemsManagement.Model.DocumentDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DocumentDescription object. The service call response (type Amazon.SimpleSystemsManagement.Model.UpdateDocumentResponse) 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=Update-SSMDocument.html&tocid=Update-SSMDocument</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Update-SSMDocument -Name RunShellScript -DocumentVersion "1" -Content (Get-Content -Raw "c:\temp\RunShellScript.json") CreatedDate : 3/1/2017 2:59:17 AM DefaultVersion : 1 Description : Run an updated script DocumentType : Command DocumentVersion : 2 Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1 HashType : Sha256 LatestVersion : 2 Name : RunShellScript Owner : 809632081692 Parameters : {commands} PlatformTypes : {Linux} SchemaVersion : 2.0 Sha1 : Status : Updating</code><remarks><para>Description</para><para>-----------</para><para>This creates a new version of a document with the updated contents of the json file you specify. The document must be in JSON format. You can obtain the document version with the "Get-SSMDocumentVersionList" cmdlet.</para><para /><para /></remarks> </example> </examples> </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>Update-SSMDocumentDefaultVersion</name> <description> <para>Invokes the UpdateDocumentDefaultVersion operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMDocumentDefaultVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Set the default version of a document. </para> </description> <syntax> <syntaxItem> <name>Update-SSMDocumentDefaultVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of a custom document that you want to set as the default version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The version of a custom document that you want to set as the default version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DocumentVersion</name> <description> <para>The version of a custom document that you want to set as the default version. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of a custom document that you want to set as the default version. </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.SimpleSystemsManagement.Model.DocumentDefaultVersionDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DocumentDefaultVersionDescription object. The service call response (type Amazon.SimpleSystemsManagement.Model.UpdateDocumentDefaultVersionResponse) 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=Update-SSMDocumentDefaultVersion.html&tocid=Update-SSMDocumentDefaultVersion</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Update-SSMDocumentDefaultVersion -Name "RunShellScript" -DocumentVersion "2" DefaultVersion Name -------------- ---- 2 RunShellScript</code><remarks><para>Description</para><para>-----------</para><para>This updates the default version of a document. You can obtain the available document versions with the "Get-SSMDocumentVersionList" cmdlet.</para><para /><para /></remarks> </example> </examples> </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>Update-SSMMaintenanceWindow</name> <description> <para>Invokes the UpdateMaintenanceWindow operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMMaintenanceWindow</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing Maintenance Window. Only specified parameters are modified. </para> </description> <syntax> <syntaxItem> <name>Update-SSMMaintenanceWindow</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowUnassociatedTarget</name> <description> <para>Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Cutoff</name> <description> <para>The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description for the update request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The duration of the Maintenance Window in hours. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para>Whether the Maintenance Window is enabled. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Replace</name> <description> <para>If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule</name> <description> <para>The schedule of the Maintenance Window in the form of a cron or rate expression. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowUnassociatedTarget</name> <description> <para>Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Cutoff</name> <description> <para>The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description for the update request. </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="False" position="Named"> <name>Duration</name> <description> <para>The duration of the Maintenance Window in hours. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para>Whether the Maintenance Window is enabled. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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>Name</name> <description> <para>The name of the Maintenance Window. </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="False" position="Named"> <name>Replace</name> <description> <para>If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule</name> <description> <para>The schedule of the Maintenance Window in the form of a cron or rate expression. </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 (ByValue, ByPropertyName)" position="1"> <name>WindowId</name> <description> <para>The ID of the Maintenance Window to update. </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.SimpleSystemsManagement.Model.UpdateMaintenanceWindowResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.UpdateMaintenanceWindowResponse 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=Update-SSMMaintenanceWindow.html&tocid=Update-SSMMaintenanceWindow</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Name "My-Renamed-MW" AllowUnassociatedTargets : False Cutoff : 1 Duration : 2 Enabled : True Name : My-Renamed-MW Schedule : cron(0 */30 * * * ? *) WindowId : mw-03eb9db42890fb82d</code><remarks><para>Description</para><para>-----------</para><para>This example updates the name of a maintenance window.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $true AllowUnassociatedTargets : False Cutoff : 1 Duration : 2 Enabled : True Name : My-Renamed-MW Schedule : cron(0 */30 * * * ? *) WindowId : mw-03eb9db42890fb82d</code><remarks><para>Description</para><para>-----------</para><para>This example enables a maintenance window.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\> Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $false AllowUnassociatedTargets : False Cutoff : 1 Duration : 2 Enabled : False Name : My-Renamed-MW Schedule : cron(0 */30 * * * ? *) WindowId : mw-03eb9db42890fb82d</code><remarks><para>Description</para><para>-----------</para><para>This example disables a maintenance window.</para><para /><para /></remarks> </example> </examples> </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>Update-SSMMaintenanceWindowTarget</name> <description> <para>Invokes the UpdateMaintenanceWindowTarget operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMMaintenanceWindowTarget</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following: The target from being an ID target to a Tag target, or a Tag target to an ID target. IDs for an ID target. Tags for a Tag target. Owner. Name. Description. If a parameter is null, then the corresponding field is not modified. </para> </description> <syntax> <syntaxItem> <name>Update-SSMMaintenanceWindowTarget</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowTargetId</name> <description> <para>The target ID to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description for the update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>A name for the update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OwnerInformation</name> <description> <para>User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Replace</name> <description> <para>If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>The targets to add or replace. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The Maintenance Window ID with which to modify the target. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description for the update. </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="False" 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>Name</name> <description> <para>A name for the update. </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="False" position="Named"> <name>OwnerInformation</name> <description> <para>User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window. </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="False" position="Named"> <name>Replace</name> <description> <para>If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>The targets to add or replace. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Target[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The Maintenance Window ID with which to modify the target. </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 (ByValue, ByPropertyName)" position="1"> <name>WindowTargetId</name> <description> <para>The target ID to modify. </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.SimpleSystemsManagement.Model.UpdateMaintenanceWindowTargetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.UpdateMaintenanceWindowTargetResponse 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=Update-SSMMaintenanceWindowTarget.html&tocid=Update-SSMMaintenanceWindowTarget</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Update-SSMMaintenanceWindowTask</name> <description> <para>Invokes the UpdateMaintenanceWindowTask operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMMaintenanceWindowTask</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values: Task ARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. Service role ARN. Task parameters. Task priority. Task MaxConcurrency and MaxErrors. Log location. If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null. </para> </description> <syntax> <syntaxItem> <name>Update-SSMMaintenanceWindowTask</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>WindowTaskId</name> <description> <para>The task ID to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Lambda_ClientContext</name> <description> <para>Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_Comment</name> <description> <para>Information about the command(s) to execute. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The new task description to specify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_DocumentHash</name> <description> <para>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_DocumentHashType</name> <description> <para>SHA-256 or SHA-1. SHA-1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentHashType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Automation_DocumentVersion</name> <description> <para>The version of an Automation document to use during task execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StepFunctions_Input</name> <description> <para>The inputs for the STEP_FUNCTION task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxConcurrency</name> <description> <para>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code> is the number of targets that are allowed to run this task in parallel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxError</name> <description> <para>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum number of errors that are allowed before the task stops being scheduled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The new task name to specify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StepFunctions_Name</name> <description> <para>The name of the STEP_FUNCTION task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationArn</name> <description> <para>An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationEvent</name> <description> <para>The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html">Setting Up Events and Notifications</a> in the <i>Amazon EC2 Systems Manager User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationConfig_NotificationType</name> <description> <para>Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.NotificationType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_OutputS3BucketName</name> <description> <para>The name of the Amazon S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_OutputS3KeyPrefix</name> <description> <para>The Amazon S3 bucket subfolder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Automation_Parameter</name> <description> <para>The parameters for the AUTOMATION task. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_Parameter</name> <description> <para>The parameters for the RUN_COMMAND task execution. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Lambda_Payload</name> <description> <para>JSON to provide to your Lambda function as input. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Priority</name> <description> <para>The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Lambda_Qualifier</name> <description> <para>(Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Replace</name> <description> <para>If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingInfo_S3BucketName</name> <description> <para>The name of an Amazon S3 bucket where execution logs are stored . </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingInfo_S3KeyPrefix</name> <description> <para>(Optional) The Amazon S3 bucket subfolder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingInfo_S3Region</name> <description> <para>The region where the Amazon S3 bucket is located. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The IAM service role ARN to modify. The system assumes this role during task execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_ServiceRoleArn</name> <description> <para>The IAM service role to assume during task execution. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target</name> <description> <para>The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TaskArn</name> <description> <para>The task ARN to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TaskParameter</name> <description> <para>The parameters to modify. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_TimeoutSecond</name> <description> <para>If this time is reached and the command has not already started executing, it doesn not execute. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The Maintenance Window ID that contains the task to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Automation_DocumentVersion</name> <description> <para>The version of an Automation document to use during task execution. </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="False" position="Named"> <name>Automation_Parameter</name> <description> <para>The parameters for the AUTOMATION task. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The new task description to specify. </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="False" 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="False" position="Named"> <name>Lambda_ClientContext</name> <description> <para>Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. </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="False" position="Named"> <name>Lambda_Payload</name> <description> <para>JSON to provide to your Lambda function as input. </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="False" position="Named"> <name>Lambda_Qualifier</name> <description> <para>(Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points. </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="False" position="Named"> <name>LoggingInfo_S3BucketName</name> <description> <para>The name of an Amazon S3 bucket where execution logs are stored . </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="False" position="Named"> <name>LoggingInfo_S3KeyPrefix</name> <description> <para>(Optional) The Amazon S3 bucket subfolder. </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="False" position="Named"> <name>LoggingInfo_S3Region</name> <description> <para>The region where the Amazon S3 bucket is located. </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="False" position="Named"> <name>MaxConcurrency</name> <description> <para>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code> is the number of targets that are allowed to run this task in parallel. </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="False" position="Named"> <name>MaxError</name> <description> <para>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum number of errors that are allowed before the task stops being scheduled. </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>Name</name> <description> <para>The new task name to specify. </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="False" position="Named"> <name>NotificationConfig_NotificationArn</name> <description> <para>An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic. </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="False" position="Named"> <name>NotificationConfig_NotificationEvent</name> <description> <para>The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html">Setting Up Events and Notifications</a> in the <i>Amazon EC2 Systems Manager User Guide</i>. </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="False" position="Named"> <name>NotificationConfig_NotificationType</name> <description> <para>Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.NotificationType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.NotificationType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Priority</name> <description> <para>The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Replace</name> <description> <para>If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_Comment</name> <description> <para>Information about the command(s) to execute. </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="False" position="Named"> <name>RunCommand_DocumentHash</name> <description> <para>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated. </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="False" position="Named"> <name>RunCommand_DocumentHashType</name> <description> <para>SHA-256 or SHA-1. SHA-1 hashes have been deprecated. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.DocumentHashType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.DocumentHashType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_OutputS3BucketName</name> <description> <para>The name of the Amazon S3 bucket. </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="False" position="Named"> <name>RunCommand_OutputS3KeyPrefix</name> <description> <para>The Amazon S3 bucket subfolder. </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="False" position="Named"> <name>RunCommand_Parameter</name> <description> <para>The parameters for the RUN_COMMAND task execution. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RunCommand_ServiceRoleArn</name> <description> <para>The IAM service role to assume during task execution. </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="False" position="Named"> <name>RunCommand_TimeoutSecond</name> <description> <para>If this time is reached and the command has not already started executing, it doesn not execute. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The IAM service role ARN to modify. The system assumes this role during task execution. </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="False" position="Named"> <name>StepFunctions_Input</name> <description> <para>The inputs for the STEP_FUNCTION task. </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="False" position="Named"> <name>StepFunctions_Name</name> <description> <para>The name of the STEP_FUNCTION task. </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="False" position="Named"> <name>Target</name> <description> <para>The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.Target[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.Target[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TaskArn</name> <description> <para>The task ARN to modify. </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="False" position="Named"> <name>TaskParameter</name> <description> <para>The parameters to modify. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>WindowId</name> <description> <para>The Maintenance Window ID that contains the task to modify. </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 (ByValue, ByPropertyName)" position="1"> <name>WindowTaskId</name> <description> <para>The task ID to modify. </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.SimpleSystemsManagement.Model.UpdateMaintenanceWindowTaskResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.UpdateMaintenanceWindowTaskResponse 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=Update-SSMMaintenanceWindowTask.html&tocid=Update-SSMMaintenanceWindowTask</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Update-SSMManagedInstanceRole</name> <description> <para>Invokes the UpdateManagedInstanceRole operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMManagedInstanceRole</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance. </para> </description> <syntax> <syntaxItem> <name>Update-SSMManagedInstanceRole</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID of the managed instance where you want to update the role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IamRole</name> <description> <para>The IAM role you want to assign or change. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>IamRole</name> <description> <para>The IAM role you want to assign or change. </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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The ID of the managed instance where you want to update the role. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.UpdateManagedInstanceRoleResponse) 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=Update-SSMManagedInstanceRole.html&tocid=Update-SSMManagedInstanceRole</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Update-SSMManagedInstanceRole -InstanceId "mi-08ab247cdf1046573" -IamRole "AutomationRole"</code><remarks><para>Description</para><para>-----------</para><para>This example updates the role of a managed instance. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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>Update-SSMPatchBaseline</name> <description> <para>Invokes the UpdatePatchBaseline operation against Amazon Simple Systems Management.</para> </description> <verb>Update</verb> <noun>SSMPatchBaseline</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies an existing patch baseline. Fields not specified in the request are left unchanged. </para> </description> <syntax> <syntaxItem> <name>Update-SSMPatchBaseline</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovedPatch</name> <description> <para>A list of explicitly approved patches for the baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovedPatchesComplianceLevel</name> <description> <para>Assigns a new compliance severity level to an existing patch baseline. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.PatchComplianceLevel</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A description of the patch baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the patch baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GlobalFilters_PatchFilter</name> <description> <para>The set of patch filters that make up the group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovalRules_PatchRule</name> <description> <para>The rules that make up the rule group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchRule[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RejectedPatch</name> <description> <para>A list of explicitly rejected patches for the baseline. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovalRules_PatchRule</name> <description> <para>The rules that make up the rule group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchRule[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.PatchRule[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApprovedPatch</name> <description> <para>A list of explicitly approved patches for the baseline. </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="False" position="Named"> <name>ApprovedPatchesComplianceLevel</name> <description> <para>Assigns a new compliance severity level to an existing patch baseline. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.PatchComplianceLevel</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.PatchComplianceLevel</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BaselineId</name> <description> <para>The ID of the patch baseline to update. </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="False" position="Named"> <name>Description</name> <description> <para>A description of the patch baseline. </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="False" 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="False" position="Named"> <name>GlobalFilters_PatchFilter</name> <description> <para>The set of patch filters that make up the group. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.PatchFilter[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.PatchFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>The name of the patch baseline. </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="False" position="Named"> <name>RejectedPatch</name> <description> <para>A list of explicitly rejected patches for the baseline. </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.SimpleSystemsManagement.Model.UpdatePatchBaselineResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleSystemsManagement.Model.UpdatePatchBaselineResponse 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=Update-SSMPatchBaseline.html&tocid=Update-SSMPatchBaseline</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Update-SSMPatchBaseline -BaselineId "pb-03da896ca3b68b639" -RejectedPatch "KB2032276","MS10-048" -ApprovedPatch "KB2124261" ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup ApprovedPatches : {KB2124261} BaselineId : pb-03da896ca3b68b639 CreatedDate : 3/3/2017 5:02:19 PM Description : Baseline containing all updates approved for production systems GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup ModifiedDate : 3/3/2017 5:22:10 PM Name : Production-Baseline RejectedPatches : {KB2032276, MS10-048}</code><remarks><para>Description</para><para>-----------</para><para>This example adds two patches as rejected and one patch as approved to an existing patch baseline.</para><para /><para /></remarks> </example> </examples> </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>Write-SSMComplianceItem</name> <description> <para>Invokes the PutComplianceItems operation against Amazon Simple Systems Management.</para> </description> <verb>Write</verb> <noun>SSMComplianceItem</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. </para> </description> <syntax> <syntaxItem> <name>Write-SSMComplianceItem</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceId</name> <description> <para>Specify an ID for this resource. For a managed instance, this is the instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ComplianceType</name> <description> <para>Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:<code>string</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExecutionSummary_ExecutionId</name> <description> <para>An ID created by the system when <code>PutComplianceItems</code> was called. For example, <code>CommandID</code> is a valid execution ID. You can use this ID in subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExecutionSummary_ExecutionTime</name> <description> <para>The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExecutionSummary_ExecutionType</name> <description> <para>The type of execution. For example, <code>Command</code> is a valid execution type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ItemContentHash</name> <description> <para>MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Item</name> <description> <para>Information about the compliance as defined by the resource type. For example, for a patch compliance type, <code>Items</code> includes information about the PatchSeverity, Classification, etc. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>Specify the type of resource. <code>ManagedInstance</code> is currently the only supported resource type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ComplianceType</name> <description> <para>Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:<code>string</code>. </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="False" position="Named"> <name>ExecutionSummary_ExecutionId</name> <description> <para>An ID created by the system when <code>PutComplianceItems</code> was called. For example, <code>CommandID</code> is a valid execution ID. You can use this ID in subsequent calls. </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="False" position="Named"> <name>ExecutionSummary_ExecutionTime</name> <description> <para>The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExecutionSummary_ExecutionType</name> <description> <para>The type of execution. For example, <code>Command</code> is a valid execution type. </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="False" 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="False" position="Named"> <name>Item</name> <description> <para>Information about the compliance as defined by the resource type. For example, for a patch compliance type, <code>Items</code> includes information about the PatchSeverity, Classification, etc. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ItemContentHash</name> <description> <para>MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>ResourceId</name> <description> <para>Specify an ID for this resource. For a managed instance, this is the instance ID. </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="False" position="Named"> <name>ResourceType</name> <description> <para>Specify the type of resource. <code>ManagedInstance</code> is currently the only supported resource type. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.PutComplianceItemsResponse) 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=Write-SSMComplianceItem.html&tocid=Write-SSMComplianceItem</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</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>Write-SSMInventory</name> <description> <para>Invokes the PutInventory operation against Amazon Simple Systems Management.</para> </description> <verb>Write</verb> <noun>SSMInventory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist. </para> </description> <syntax> <syntaxItem> <name>Write-SSMInventory</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>One or more instance IDs where you want to add or update inventory items. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Item</name> <description> <para>The inventory items that you want to add or update on instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InventoryItem[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>One or more instance IDs where you want to add or update inventory items. </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="False" position="Named"> <name>Item</name> <description> <para>The inventory items that you want to add or update on instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.Model.InventoryItem[]</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.Model.InventoryItem[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleSystemsManagement.Model.PutInventoryResponse) 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=Write-SSMInventory.html&tocid=Write-SSMInventory</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> $data = New-Object "System.Collections.Generic.Dictionary[System.String,System.String]" PS C:\> $data.Add("RackLocation", "Bay B/Row C/Rack D/Shelf F") PS C:\> $items = New-Object "System.Collections.Generic.List[System.Collections.Generic.Dictionary[System.String, System.String]]" PS C:\> $items.Add($data) PS C:\> $customInventoryItem = New-Object Amazon.SimpleSystemsManagement.Model.InventoryItem PS C:\> $customInventoryItem.CaptureTime = "2016-08-22T10:01:01Z" PS C:\> $customInventoryItem.Content = $items PS C:\> $customInventoryItem.TypeName = "Custom:TestRackInfo2" PS C:\> $customInventoryItem.SchemaVersion = "1.0" PS C:\> $inventoryItems = @($customInventoryItem) PS C:\> Write-SSMInventory -InstanceId "i-0cb2b964d3e14fd9f" -Item $inventoryItems</code><remarks><para>Description</para><para>-----------</para><para>This example assigns rack location information to an instance. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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>Write-SSMParameter</name> <description> <para>Invokes the PutParameter operation against Amazon Simple Systems Management.</para> </description> <verb>Write</verb> <noun>SSMParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Add one or more parameters to the system. </para> </description> <syntax> <syntaxItem> <name>Write-SSMParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the parameter that you want to add to the system. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowedPattern</name> <description> <para>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$ </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>Information about the parameter that you want to add to the system </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>KeyId</name> <description> <para>The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Overwrite</name> <description> <para>Overwrite an existing parameter. If not specified, will default to "false". </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Type</name> <description> <para>The type of parameter that you want to add to the system. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ParameterType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Value</name> <description> <para>The parameter value that you want to add to the system. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowedPattern</name> <description> <para>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$ </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="False" position="Named"> <name>Description</name> <description> <para>Information about the parameter that you want to add to the system </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="False" 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>KeyId</name> <description> <para>The KMS Key ID that you want to use to encrypt a parameter when you choose the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account. </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 (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the parameter that you want to add to the system. </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="False" position="Named"> <name>Overwrite</name> <description> <para>Overwrite an existing parameter. If not specified, will default to "false". </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Type</name> <description> <para>The type of parameter that you want to add to the system. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleSystemsManagement.ParameterType</parameterValue> <type> <name>Amazon.SimpleSystemsManagement.ParameterType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Value</name> <description> <para>The parameter value that you want to add to the system. </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>System.Int64</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Int64 object. The service call response (type Amazon.SimpleSystemsManagement.Model.PutParameterResponse) 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=Write-SSMParameter.html&tocid=Write-SSMParameter</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> <navigationLink> <linkText>Service User Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/APIReference/</uri> </navigationLink> <navigationLink> <linkText>Microsoft Windows Guide:</linkText> <uri>https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\> Write-SSMParameter -Name "Welcome" -Type "String" -Value "helloWorld"</code><remarks><para>Description</para><para>-----------</para><para>This example creates a parameter. There is no output if the command succeeds.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\> Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true</code><remarks><para>Description</para><para>-----------</para><para>This example changes a parameter. There is no output if the command succeeds.</para><para /><para /></remarks> </example> </examples> </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>Add-SNSPermission</name> <description> <para>Invokes the AddPermission operation against Amazon Simple Notification Service.</para> </description> <verb>Add</verb> <noun>SNSPermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. </para> </description> <syntax> <syntaxItem> <name>Add-SNSPermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic whose access control policy you wish to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Label</name> <description> <para>A unique identifier for the new policy statement. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AWSAccountId</name> <description> <para>The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>ActionName</name> <description> <para>The action you want to allow for the specified principal(s). Valid values: any Amazon SNS action name. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>ActionName</name> <description> <para>The action you want to allow for the specified principal(s). Valid values: any Amazon SNS action name. </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="False" position="3"> <name>AWSAccountId</name> <description> <para>The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. </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="False" 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="False" position="2"> <name>Label</name> <description> <para>A unique identifier for the new policy statement. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic whose access control policy you wish to modify. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TopicArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.AddPermissionResponse) 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=Add-SNSPermission.html&tocid=Add-SNSPermission</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Confirm-SNSSubscription</name> <description> <para>Invokes the ConfirmSubscription operation against Amazon Simple Notification Service.</para> </description> <verb>Confirm</verb> <noun>SNSSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </para> </description> <syntax> <syntaxItem> <name>Confirm-SNSSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic for which you wish to confirm a subscription. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Token</name> <description> <para>Short-lived token sent to an endpoint during the <code>Subscribe</code> action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AuthenticateOnUnsubscribe</name> <description> <para>Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AuthenticateOnUnsubscribe</name> <description> <para>Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. </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="False" 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="False" position="2"> <name>Token</name> <description> <para>Short-lived token sent to an endpoint during the <code>Subscribe</code> action. </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 (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic for which you wish to confirm a subscription. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleNotificationService.Model.ConfirmSubscriptionResponse) 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=Confirm-SNSSubscription.html&tocid=Confirm-SNSSubscription</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Connect-SNSNotification</name> <description> <para>Invokes the Subscribe operation against Amazon Simple Notification Service.</para> </description> <verb>Connect</verb> <noun>SNSNotification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three days. </para> </description> <syntax> <syntaxItem> <name>Connect-SNSNotification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic you want to subscribe to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Protocol</name> <description> <para>The protocol you want to use. Supported protocols include: - <code>http</code> -- delivery of JSON-encoded message via HTTP POST - <code>https</code> -- delivery of JSON-encoded message via HTTPS POST - <code>email</code> -- delivery of message via SMTP - <code>email-json</code> -- delivery of JSON-encoded message via SMTP - <code>sms</code> -- delivery of message via SMS - <code>sqs</code> -- delivery of JSON-encoded message to an Amazon SQS queue - <code>application</code> -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device. - <code>lambda</code> -- delivery of JSON-encoded message to an AWS Lambda function. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Endpoint</name> <description> <para>The endpoint that you want to receive notifications. Endpoints vary by protocol: - For the <code>http</code> protocol, the endpoint is an URL beginning with "http://" - For the <code>https</code> protocol, the endpoint is a URL beginning with "https://" - For the <code>email</code> protocol, the endpoint is an email address - For the <code>email-json</code> protocol, the endpoint is an email address - For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device - For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue - For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device. - For the <code>lambda</code> protocol, the endpoint is the ARN of an AWS Lambda function. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Endpoint</name> <description> <para>The endpoint that you want to receive notifications. Endpoints vary by protocol: - For the <code>http</code> protocol, the endpoint is an URL beginning with "http://" - For the <code>https</code> protocol, the endpoint is a URL beginning with "https://" - For the <code>email</code> protocol, the endpoint is an email address - For the <code>email-json</code> protocol, the endpoint is an email address - For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device - For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue - For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device. - For the <code>lambda</code> protocol, the endpoint is the ARN of an AWS Lambda function. </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="False" 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="False" position="2"> <name>Protocol</name> <description> <para>The protocol you want to use. Supported protocols include: - <code>http</code> -- delivery of JSON-encoded message via HTTP POST - <code>https</code> -- delivery of JSON-encoded message via HTTPS POST - <code>email</code> -- delivery of message via SMTP - <code>email-json</code> -- delivery of JSON-encoded message via SMTP - <code>sms</code> -- delivery of message via SMS - <code>sqs</code> -- delivery of JSON-encoded message to an Amazon SQS queue - <code>application</code> -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device. - <code>lambda</code> -- delivery of JSON-encoded message to an AWS Lambda function. </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 (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic you want to subscribe to. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleNotificationService.Model.SubscribeResponse) 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=Connect-SNSNotification.html&tocid=Connect-SNSNotification</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Disconnect-SNSNotification</name> <description> <para>Invokes the Unsubscribe operation against Amazon Simple Notification Service.</para> </description> <verb>Disconnect</verb> <noun>SNSNotification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the <code>Unsubscribe</code> call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the <code>Unsubscribe</code> request was unintended. </para> </description> <syntax> <syntaxItem> <name>Disconnect-SNSNotification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionArn</name> <description> <para>The ARN of the subscription to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SubscriptionArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SubscriptionArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>SubscriptionArn</name> <description> <para>The ARN of the subscription to be deleted. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SubscriptionArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.UnsubscribeResponse) 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=Disconnect-SNSNotification.html&tocid=Disconnect-SNSNotification</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Enable-SNSPhoneNumber</name> <description> <para>Invokes the OptInPhoneNumber operation against Amazon Simple Notification Service.</para> </description> <verb>Enable</verb> <noun>SNSPhoneNumber</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number. You can opt in a phone number only once every 30 days. </para> </description> <syntax> <syntaxItem> <name>Enable-SNSPhoneNumber</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PhoneNumber</name> <description> <para>The phone number to opt in. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PhoneNumber parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PhoneNumber parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>PhoneNumber</name> <description> <para>The phone number to opt in. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PhoneNumber parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.OptInPhoneNumberResponse) 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=Enable-SNSPhoneNumber.html&tocid=Enable-SNSPhoneNumber</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSEndpointAttribute</name> <description> <para>Invokes the GetEndpointAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSEndpointAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </para> </description> <syntax> <syntaxItem> <name>Get-SNSEndpointAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EndpointArn</name> <description> <para>EndpointArn for GetEndpointAttributes input. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EndpointArn</name> <description> <para>EndpointArn for GetEndpointAttributes input. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleNotificationService.Model.GetEndpointAttributesResponse) 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-SNSEndpointAttribute.html&tocid=Get-SNSEndpointAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSEndpointsByPlatformApplication</name> <description> <para>Invokes the ListEndpointsByPlatformApplication operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSEndpointsByPlatformApplication</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListEndpointsByPlatformApplication</code> again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNSEndpointsByPlatformApplication</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. </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.SimpleNotificationService.Model.Endpoint</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Endpoint objects. The service call response (type Amazon.SimpleNotificationService.Model.ListEndpointsByPlatformApplicationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNSEndpointsByPlatformApplication.html&tocid=Get-SNSEndpointsByPlatformApplication</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSPhoneNumbersOptedOut</name> <description> <para>Invokes the ListPhoneNumbersOptedOut operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSPhoneNumbersOptedOut</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for <code>ListPhoneNumbersOptedOut</code> are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a <code>NextToken</code> string will be returned. To receive the next page, you call <code>ListPhoneNumbersOptedOut</code> again using the <code>NextToken</code> string received from the previous call. When there are no more records to return, <code>NextToken</code> will be null. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNSPhoneNumbersOptedOut</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>A <code>NextToken</code> string is used when you call the <code>ListPhoneNumbersOptedOut</code> action to retrieve additional records that are available after the first page of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>A <code>NextToken</code> string is used when you call the <code>ListPhoneNumbersOptedOut</code> action to retrieve additional records that are available after the first page of results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleNotificationService.Model.ListPhoneNumbersOptedOutResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNSPhoneNumbersOptedOut.html&tocid=Get-SNSPhoneNumbersOptedOut</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSPlatformApplicationAttribute</name> <description> <para>Invokes the GetPlatformApplicationAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSPlatformApplicationAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </para> </description> <syntax> <syntaxItem> <name>Get-SNSPlatformApplicationAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn for GetPlatformApplicationAttributesInput. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn for GetPlatformApplicationAttributesInput. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleNotificationService.Model.GetPlatformApplicationAttributesResponse) 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-SNSPlatformApplicationAttribute.html&tocid=Get-SNSPlatformApplicationAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSPlatformApplicationList</name> <description> <para>Invokes the ListPlatformApplications operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSPlatformApplicationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNSPlatformApplicationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleNotificationService.Model.PlatformApplication</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PlatformApplication objects. The service call response (type Amazon.SimpleNotificationService.Model.ListPlatformApplicationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNSPlatformApplicationList.html&tocid=Get-SNSPlatformApplicationList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSSMSAttribute</name> <description> <para>Invokes the GetSMSAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSSMSAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the settings for sending SMS messages from your account. These settings are set with the <code>SetSMSAttributes</code> action. </para> </description> <syntax> <syntaxItem> <name>Get-SNSSMSAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Attribute</name> <description> <para>A list of the individual attribute names, such as <code>MonthlySpendLimit</code>, for which you want values. For all attribute names, see <a href="http://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html">SetSMSAttributes</a>. If you don't use this parameter, Amazon SNS returns all SMS attributes. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Attribute</name> <description> <para>A list of the individual attribute names, such as <code>MonthlySpendLimit</code>, for which you want values. For all attribute names, see <a href="http://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html">SetSMSAttributes</a>. If you don't use this parameter, Amazon SNS returns all SMS attributes. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleNotificationService.Model.GetSMSAttributesResponse) 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-SNSSMSAttribute.html&tocid=Get-SNSSMSAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSSubscription</name> <description> <para>Invokes the ListSubscriptions operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNSSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>Token returned by the previous <code>ListSubscriptions</code> request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>Token returned by the previous <code>ListSubscriptions</code> request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleNotificationService.Model.Subscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Subscription objects. The service call response (type Amazon.SimpleNotificationService.Model.ListSubscriptionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNSSubscription.html&tocid=Get-SNSSubscription</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSSubscriptionAttribute</name> <description> <para>Invokes the GetSubscriptionAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSSubscriptionAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all of the properties of a subscription. </para> </description> <syntax> <syntaxItem> <name>Get-SNSSubscriptionAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionArn</name> <description> <para>The ARN of the subscription whose properties you want to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionArn</name> <description> <para>The ARN of the subscription whose properties you want to get. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleNotificationService.Model.GetSubscriptionAttributesResponse) 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-SNSSubscriptionAttribute.html&tocid=Get-SNSSubscriptionAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSSubscriptionByTopic</name> <description> <para>Invokes the ListSubscriptionsByTopic operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSSubscriptionByTopic</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNSSubscriptionByTopic</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic for which you wish to find subscriptions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>Token returned by the previous <code>ListSubscriptionsByTopic</code> request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>Token returned by the previous <code>ListSubscriptionsByTopic</code> request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic for which you wish to find subscriptions. </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.SimpleNotificationService.Model.Subscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Subscription objects. The service call response (type Amazon.SimpleNotificationService.Model.ListSubscriptionsByTopicResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNSSubscriptionByTopic.html&tocid=Get-SNSSubscriptionByTopic</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSTopic</name> <description> <para>Invokes the ListTopics operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSTopic</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SNSTopic</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>Token returned by the previous <code>ListTopics</code> request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>Token returned by the previous <code>ListTopics</code> request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleNotificationService.Model.Topic</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Topic objects. The service call response (type Amazon.SimpleNotificationService.Model.ListTopicsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SNSTopic.html&tocid=Get-SNSTopic</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Get-SNSTopicAttribute</name> <description> <para>Invokes the GetTopicAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Get</verb> <noun>SNSTopicAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. </para> </description> <syntax> <syntaxItem> <name>Get-SNSTopicAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic whose properties you want to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic whose properties you want to get. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleNotificationService.Model.GetTopicAttributesResponse) 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-SNSTopicAttribute.html&tocid=Get-SNSTopicAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>New-SNSPlatformApplication</name> <description> <para>Invokes the CreatePlatformApplication operation against Amazon Simple Notification Service.</para> </description> <verb>New</verb> <noun>SNSPlatformApplication</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the <code>CreatePlatformApplication</code> action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key". For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using <code>CreatePlatformApplication</code> is then used as an attribute for the <code>CreatePlatformEndpoint</code> action. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-apns.html">Getting Started with Apple Push Notification Service</a>, <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-adm.html">Getting Started with Amazon Device Messaging</a>, <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-baidu.html">Getting Started with Baidu Cloud Push</a>, <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-gcm.html">Getting Started with Google Cloud Messaging for Android</a>, <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-mpns.html">Getting Started with MPNS</a>, or <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-wns.html">Getting Started with WNS</a>. </para> </description> <syntax> <syntaxItem> <name>New-SNSPlatformApplication</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Platform</name> <description> <para>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Attribute</name> <description> <para>For a list of attributes, see <a href="http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html">SetPlatformApplicationAttributes</a> </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Attribute</name> <description> <para>For a list of attributes, see <a href="http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html">SetPlatformApplicationAttributes</a> </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long. </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="False" position="2"> <name>Platform</name> <description> <para>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging). </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleNotificationService.Model.CreatePlatformApplicationResponse) 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=New-SNSPlatformApplication.html&tocid=New-SNSPlatformApplication</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>New-SNSPlatformEndpoint</name> <description> <para>Invokes the CreatePlatformEndpoint operation against Amazon Simple Notification Service.</para> </description> <verb>New</verb> <noun>SNSPlatformEndpoint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. <code>CreatePlatformEndpoint</code> requires the PlatformApplicationArn that is returned from <code>CreatePlatformApplication</code>. The EndpointArn that is returned when using <code>CreatePlatformEndpoint</code> can then be used by the <code>Publish</code> action to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for Baidu</a>. </para> </description> <syntax> <syntaxItem> <name>New-SNSPlatformEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Token</name> <description> <para>Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Attribute</name> <description> <para>For a list of attributes, see <a href="http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html">SetEndpointAttributes</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>CustomUserData</name> <description> <para>Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Attribute</name> <description> <para>For a list of attributes, see <a href="http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html">SetEndpointAttributes</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>CustomUserData</name> <description> <para>Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. </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="False" position="2"> <name>Token</name> <description> <para>Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleNotificationService.Model.CreatePlatformEndpointResponse) 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=New-SNSPlatformEndpoint.html&tocid=New-SNSPlatformEndpoint</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>New-SNSTopic</name> <description> <para>Invokes the CreateTopic operation against Amazon Simple Notification Service.</para> </description> <verb>New</verb> <noun>SNSTopic</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. </para> </description> <syntax> <syntaxItem> <name>New-SNSTopic</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleNotificationService.Model.CreateTopicResponse) 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=New-SNSTopic.html&tocid=New-SNSTopic</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Publish-SNSMessage</name> <description> <para>Invokes the Publish operation against Amazon Simple Notification Service.</para> </description> <verb>Publish</verb> <noun>SNSMessage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol. To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. For more information about formatting messages, see <a href="http://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html">Send Custom Platform-Specific Payloads in Messages to Mobile Devices</a>. </para> </description> <syntax> <syntaxItem> <name>Publish-SNSMessage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The topic you want to publish to. If you don't specify a value for the <code>TopicArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TargetArn</code> parameters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Message</name> <description> <para>The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints: - Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. - The values will be parsed (unescaped) before they are used in outgoing messages. - Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending). - Values have a minimum length of 0 (the empty string, "", is allowed). - Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes). - Non-string values will cause the key to be ignored. - Keys that do not correspond to supported transport protocols are ignored. - Duplicate keys are not allowed. - Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>MessageStructure</name> <description> <para>Set <code>MessageStructure</code> to <code>json</code> if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set <code>MessageStructure</code> to <code>json</code>, the value of the <code>Message</code> parameter must: - be a syntactically valid JSON object; and - contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). For information about sending different messages for each protocol using the AWS Management Console, go to <a href="http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol">Create Different Messages for Each Protocol</a> in the <i>Amazon Simple Notification Service Getting Started Guide</i>. Valid value: <code>json</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Subject</name> <description> <para>Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageAttribute</name> <description> <para>Message attributes for Publish action. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PhoneNumber</name> <description> <para>The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the <code>PhoneNumber</code> parameter, you must specify a value for the <code>TargetArn</code> or <code>TopicArn</code> parameters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetArn</name> <description> <para>Either TopicArn or EndpointArn, but not both. If you don't specify a value for the <code>TargetArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TopicArn</code> parameters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>Message</name> <description> <para>The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints: - Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. - The values will be parsed (unescaped) before they are used in outgoing messages. - Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending). - Values have a minimum length of 0 (the empty string, "", is allowed). - Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes). - Non-string values will cause the key to be ignored. - Keys that do not correspond to supported transport protocols are ignored. - Duplicate keys are not allowed. - Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery). </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="False" position="Named"> <name>MessageAttribute</name> <description> <para>Message attributes for Publish action. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>MessageStructure</name> <description> <para>Set <code>MessageStructure</code> to <code>json</code> if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set <code>MessageStructure</code> to <code>json</code>, the value of the <code>Message</code> parameter must: - be a syntactically valid JSON object; and - contain at least a top-level JSON key of "default" with a value that is a string. You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). For information about sending different messages for each protocol using the AWS Management Console, go to <a href="http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol">Create Different Messages for Each Protocol</a> in the <i>Amazon Simple Notification Service Getting Started Guide</i>. Valid value: <code>json</code> </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="False" position="Named"> <name>PhoneNumber</name> <description> <para>The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the <code>PhoneNumber</code> parameter, you must specify a value for the <code>TargetArn</code> or <code>TopicArn</code> parameters. </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="False" position="4"> <name>Subject</name> <description> <para>Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long. </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="False" position="Named"> <name>TargetArn</name> <description> <para>Either TopicArn or EndpointArn, but not both. If you don't specify a value for the <code>TargetArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TopicArn</code> parameters. </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 (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The topic you want to publish to. If you don't specify a value for the <code>TopicArn</code> parameter, you must specify a value for the <code>PhoneNumber</code> or <code>TargetArn</code> parameters. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleNotificationService.Model.PublishResponse) 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=Publish-SNSMessage.html&tocid=Publish-SNSMessage</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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-SNSEndpoint</name> <description> <para>Invokes the DeleteEndpoint operation against Amazon Simple Notification Service.</para> </description> <verb>Remove</verb> <noun>SNSEndpoint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic. </para> </description> <syntax> <syntaxItem> <name>Remove-SNSEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EndpointArn</name> <description> <para>EndpointArn of endpoint to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EndpointArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EndpointArn</name> <description> <para>EndpointArn of endpoint to delete. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EndpointArn parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the EndpointArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.DeleteEndpointResponse) 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-SNSEndpoint.html&tocid=Remove-SNSEndpoint</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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-SNSPermission</name> <description> <para>Invokes the RemovePermission operation against Amazon Simple Notification Service.</para> </description> <verb>Remove</verb> <noun>SNSPermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes a statement from a topic's access control policy. </para> </description> <syntax> <syntaxItem> <name>Remove-SNSPermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic whose access control policy you wish to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Label</name> <description> <para>The unique label of the statement you want to remove. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>Label</name> <description> <para>The unique label of the statement you want to remove. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic whose access control policy you wish to modify. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TopicArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.RemovePermissionResponse) 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-SNSPermission.html&tocid=Remove-SNSPermission</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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-SNSPlatformApplication</name> <description> <para>Invokes the DeletePlatformApplication operation against Amazon Simple Notification Service.</para> </description> <verb>Remove</verb> <noun>SNSPlatformApplication</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-SNSPlatformApplication</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn of platform application object to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PlatformApplicationArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PlatformApplicationArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn of platform application object to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PlatformApplicationArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.DeletePlatformApplicationResponse) 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-SNSPlatformApplication.html&tocid=Remove-SNSPlatformApplication</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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-SNSTopic</name> <description> <para>Invokes the DeleteTopic operation against Amazon Simple Notification Service.</para> </description> <verb>Remove</verb> <noun>SNSTopic</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. </para> </description> <syntax> <syntaxItem> <name>Remove-SNSTopic</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic you want to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TopicArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.DeleteTopicResponse) 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-SNSTopic.html&tocid=Remove-SNSTopic</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Set-SNSEndpointAttribute</name> <description> <para>Invokes the SetEndpointAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Set</verb> <noun>SNSEndpointAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </para> </description> <syntax> <syntaxItem> <name>Set-SNSEndpointAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EndpointArn</name> <description> <para>EndpointArn used for SetEndpointAttributes action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Attribute</name> <description> <para>A map of the endpoint attributes. Attributes in this map include the following: - <code>CustomUserData</code> -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. - <code>Enabled</code> -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. - <code>Token</code> -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EndpointArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Attribute</name> <description> <para>A map of the endpoint attributes. Attributes in this map include the following: - <code>CustomUserData</code> -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. - <code>Enabled</code> -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token. - <code>Token</code> -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EndpointArn</name> <description> <para>EndpointArn used for SetEndpointAttributes action. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EndpointArn parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the EndpointArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.SetEndpointAttributesResponse) 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=Set-SNSEndpointAttribute.html&tocid=Set-SNSEndpointAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Set-SNSPlatformApplicationAttribute</name> <description> <para>Invokes the SetPlatformApplicationAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Set</verb> <noun>SNSPlatformApplicationAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. For information on configuring attributes for message delivery status, see <a href="http://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html">Using Amazon SNS Application Attributes for Message Delivery Status</a>. </para> </description> <syntax> <syntaxItem> <name>Set-SNSPlatformApplicationAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn for SetPlatformApplicationAttributes action. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Attribute</name> <description> <para>A map of the platform application attributes. Attributes in this map include the following: - <code>PlatformCredential</code> -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". - <code>PlatformPrincipal</code> -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". - <code>EventEndpointCreated</code> -- Topic ARN to which EndpointCreated event notifications should be sent. - <code>EventEndpointDeleted</code> -- Topic ARN to which EndpointDeleted event notifications should be sent. - <code>EventEndpointUpdated</code> -- Topic ARN to which EndpointUpdate event notifications should be sent. - <code>EventDeliveryFailure</code> -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints. - <code>SuccessFeedbackRoleArn</code> -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. - <code>FailureFeedbackRoleArn</code> -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. - <code>SuccessFeedbackSampleRate</code> -- Sample rate percentage (0-100) of successfully delivered messages. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PlatformApplicationArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Attribute</name> <description> <para>A map of the platform application attributes. Attributes in this map include the following: - <code>PlatformCredential</code> -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". - <code>PlatformPrincipal</code> -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". - <code>EventEndpointCreated</code> -- Topic ARN to which EndpointCreated event notifications should be sent. - <code>EventEndpointDeleted</code> -- Topic ARN to which EndpointDeleted event notifications should be sent. - <code>EventEndpointUpdated</code> -- Topic ARN to which EndpointUpdate event notifications should be sent. - <code>EventDeliveryFailure</code> -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints. - <code>SuccessFeedbackRoleArn</code> -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. - <code>FailureFeedbackRoleArn</code> -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf. - <code>SuccessFeedbackSampleRate</code> -- Sample rate percentage (0-100) of successfully delivered messages. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PlatformApplicationArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>PlatformApplicationArn</name> <description> <para>PlatformApplicationArn for SetPlatformApplicationAttributes action. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PlatformApplicationArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.SetPlatformApplicationAttributesResponse) 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=Set-SNSPlatformApplicationAttribute.html&tocid=Set-SNSPlatformApplicationAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Set-SNSSMSAttribute</name> <description> <para>Invokes the SetSMSAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Set</verb> <noun>SNSSMSAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports. You can override some of these settings for a single message when you use the <code>Publish</code> action with the <code>MessageAttributes.entry.N</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html">Sending an SMS Message</a> in the <i>Amazon SNS Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Set-SNSSMSAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Attribute</name> <description> <para>The default settings for sending SMS messages from your account. You can set values for the following attribute names: <code>MonthlySpendLimit</code> – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes. <important><para>Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.</para></important> By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to exceed the maximum, contact <a href="https://aws.amazon.com/premiumsupport/">AWS Support</a> or your AWS sales representative for a service limit increase. <code>DeliveryStatusIAMRole</code> – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information. <code>DeliveryStatusSuccessSamplingRate</code> – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to <code>0</code>. To write logs for 10% of your successful deliveries, set it to <code>10</code>. <code>DefaultSenderID</code> – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter. <code>DefaultSMSType</code> – The type of SMS message that you will send by default. You can assign the following values: - <code>Promotional</code> – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost. - <code>Transactional</code> – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability. <code>UsageReportS3Bucket</code> – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account: - Time that the message was published (in UTC) - Message ID - Destination phone number - Message type - Delivery status - Message price (in USD) - Part number (a message is split into multiple parts if it is too long for a single message) - Total number of parts To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the <code>s3:PutObject</code> and <code>s3:GetBucketLocation</code> actions. For an example bucket policy and usage report, see <a href="http://docs.aws.amazon.com/sns/latest/dg/sms_stats.html">Monitoring SMS Activity</a> in the <i>Amazon SNS Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Attribute parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Attribute</name> <description> <para>The default settings for sending SMS messages from your account. You can set values for the following attribute names: <code>MonthlySpendLimit</code> – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes. <important><para>Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.</para></important> By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to exceed the maximum, contact <a href="https://aws.amazon.com/premiumsupport/">AWS Support</a> or your AWS sales representative for a service limit increase. <code>DeliveryStatusIAMRole</code> – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information. <code>DeliveryStatusSuccessSamplingRate</code> – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to <code>0</code>. To write logs for 10% of your successful deliveries, set it to <code>10</code>. <code>DefaultSenderID</code> – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter. <code>DefaultSMSType</code> – The type of SMS message that you will send by default. You can assign the following values: - <code>Promotional</code> – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost. - <code>Transactional</code> – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability. <code>UsageReportS3Bucket</code> – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account: - Time that the message was published (in UTC) - Message ID - Destination phone number - Message type - Delivery status - Message price (in USD) - Part number (a message is split into multiple parts if it is too long for a single message) - Total number of parts To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the <code>s3:PutObject</code> and <code>s3:GetBucketLocation</code> actions. For an example bucket policy and usage report, see <a href="http://docs.aws.amazon.com/sns/latest/dg/sms_stats.html">Monitoring SMS Activity</a> in the <i>Amazon SNS Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Attribute parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Attribute parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.SetSMSAttributesResponse) 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=Set-SNSSMSAttribute.html&tocid=Set-SNSSMSAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Set-SNSSubscriptionAttribute</name> <description> <para>Invokes the SetSubscriptionAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Set</verb> <noun>SNSSubscriptionAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Allows a subscription owner to set an attribute of the topic to a new value. </para> </description> <syntax> <syntaxItem> <name>Set-SNSSubscriptionAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionArn</name> <description> <para>The ARN of the subscription to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AttributeName</name> <description> <para>The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: <code>DeliveryPolicy</code> | <code>RawMessageDelivery</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AttributeValue</name> <description> <para>The new value for the attribute in JSON format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SubscriptionArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AttributeName</name> <description> <para>The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: <code>DeliveryPolicy</code> | <code>RawMessageDelivery</code> </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="False" position="3"> <name>AttributeValue</name> <description> <para>The new value for the attribute in JSON format. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SubscriptionArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>SubscriptionArn</name> <description> <para>The ARN of the subscription to modify. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SubscriptionArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.SetSubscriptionAttributesResponse) 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=Set-SNSSubscriptionAttribute.html&tocid=Set-SNSSubscriptionAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Set-SNSTopicAttribute</name> <description> <para>Invokes the SetTopicAttributes operation against Amazon Simple Notification Service.</para> </description> <verb>Set</verb> <noun>SNSTopicAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Allows a topic owner to set an attribute of the topic to a new value. </para> </description> <syntax> <syntaxItem> <name>Set-SNSTopicAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AttributeName</name> <description> <para>The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: <code>Policy</code> | <code>DisplayName</code> | <code>DeliveryPolicy</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AttributeValue</name> <description> <para>The new value for the attribute. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AttributeName</name> <description> <para>The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: <code>Policy</code> | <code>DisplayName</code> | <code>DeliveryPolicy</code> </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="False" position="3"> <name>AttributeValue</name> <description> <para>The new value for the attribute. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>TopicArn</name> <description> <para>The ARN of the topic to modify. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TopicArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleNotificationService.Model.SetTopicAttributesResponse) 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=Set-SNSTopicAttribute.html&tocid=Set-SNSTopicAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Test-SNSIfPhoneNumberIsOptedOut</name> <description> <para>Invokes the CheckIfPhoneNumberIsOptedOut operation against Amazon Simple Notification Service.</para> </description> <verb>Test</verb> <noun>SNSIfPhoneNumberIsOptedOut</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out. To resume sending messages, you can opt in the number by using the <code>OptInPhoneNumber</code> action. </para> </description> <syntax> <syntaxItem> <name>Test-SNSIfPhoneNumberIsOptedOut</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PhoneNumber</name> <description> <para>The phone number for which you want to check the opt out status. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PhoneNumber</name> <description> <para>The phone number for which you want to check the opt out status. </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>System.Boolean</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Boolean object. The service call response (type Amazon.SimpleNotificationService.Model.CheckIfPhoneNumberIsOptedOutResponse) 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=Test-SNSIfPhoneNumberIsOptedOut.html&tocid=Test-SNSIfPhoneNumberIsOptedOut</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/sns/latest/api/</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>Confirm-SESDomainDkim</name> <description> <para>Invokes the VerifyDomainDkim operation against Amazon Simple Email Service.</para> </description> <verb>Confirm</verb> <noun>SESDomainDkim</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a set of DKIM tokens for a domain. DKIM <i>tokens</i> are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. You can execute this operation no more than once per second. To enable or disable Easy DKIM signing for a domain, use the <code>SetIdentityDkimEnabled</code> operation. For more information about creating DNS records using DKIM tokens, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Confirm-SESDomainDkim</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Domain</name> <description> <para>The name of the domain to be verified for Easy DKIM signing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Domain</name> <description> <para>The name of the domain to be verified for Easy DKIM signing. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.VerifyDomainDkimResponse) 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=Confirm-SESDomainDkim.html&tocid=Confirm-SESDomainDkim</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Confirm-SESDomainIdentity</name> <description> <para>Invokes the VerifyDomainIdentity operation against Amazon Simple Email Service.</para> </description> <verb>Confirm</verb> <noun>SESDomainIdentity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds a domain to the list of identities for your Amazon SES account and attempts to verify it. For more information about verifying domains, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Confirm-SESDomainIdentity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Domain</name> <description> <para>The domain to be verified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Domain</name> <description> <para>The domain to be verified. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleEmail.Model.VerifyDomainIdentityResponse) 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=Confirm-SESDomainIdentity.html&tocid=Confirm-SESDomainIdentity</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Confirm-SESEmailAddress</name> <description> <para>Invokes the VerifyEmailAddress operation against Amazon Simple Email Service.</para> </description> <verb>Confirm</verb> <noun>SESEmailAddress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deprecated. Use the <code>VerifyEmailIdentity</code> operation to verify a new email address. </para> </description> <syntax> <syntaxItem> <name>Confirm-SESEmailAddress</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EmailAddress</name> <description> <para>The email address to be verified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EmailAddress</name> <description> <para>The email address to be verified. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the EmailAddress parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.VerifyEmailAddressResponse) 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=Confirm-SESEmailAddress.html&tocid=Confirm-SESEmailAddress</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Confirm-SESEmailIdentity</name> <description> <para>Invokes the VerifyEmailIdentity operation against Amazon Simple Email Service.</para> </description> <verb>Confirm</verb> <noun>SESEmailIdentity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. This operation causes a confirmation email message to be sent to the specified address. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Confirm-SESEmailIdentity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EmailAddress</name> <description> <para>The email address to be verified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EmailAddress</name> <description> <para>The email address to be verified. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the EmailAddress parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.VerifyEmailIdentityResponse) 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=Confirm-SESEmailIdentity.html&tocid=Confirm-SESEmailIdentity</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Copy-SESReceiptRuleSet</name> <description> <para>Invokes the CloneReceiptRuleSet operation against Amazon Simple Email Service.</para> </description> <verb>Copy</verb> <noun>SESReceiptRuleSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. For information about setting up rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Copy-SESReceiptRuleSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OriginalRuleSetName</name> <description> <para>The name of the rule set to clone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the rule set to create. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the OriginalRuleSetName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>OriginalRuleSetName</name> <description> <para>The name of the rule set to clone. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the OriginalRuleSetName parameter. By default, this cmdlet does not generate any output. </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>RuleSetName</name> <description> <para>The name of the rule set to create. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the OriginalRuleSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.CloneReceiptRuleSetResponse) 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=Copy-SESReceiptRuleSet.html&tocid=Copy-SESReceiptRuleSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESActiveReceiptRuleSet</name> <description> <para>Invokes the DescribeActiveReceiptRuleSet operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESActiveReceiptRuleSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESActiveReceiptRuleSet</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.SimpleEmail.Model.DescribeActiveReceiptRuleSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleEmail.Model.DescribeActiveReceiptRuleSetResponse 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-SESActiveReceiptRuleSet.html&tocid=Get-SESActiveReceiptRuleSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESConfigurationSet</name> <description> <para>Invokes the DescribeConfigurationSet operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESConfigurationSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the details of the specified configuration set. For information about using configuration sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESConfigurationSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationSetAttributeName</name> <description> <para>A list of configuration set attributes to return. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationSetAttributeName</name> <description> <para>A list of configuration set attributes to return. </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 (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to describe. </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.SimpleEmail.Model.DescribeConfigurationSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleEmail.Model.DescribeConfigurationSetResponse 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-SESConfigurationSet.html&tocid=Get-SESConfigurationSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESConfigurationSetList</name> <description> <para>Invokes the ListConfigurationSets operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESConfigurationSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Provides a list of the configuration sets associated with your Amazon SES account. For information about using configuration sets, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Monitoring Your Amazon SES Sending Activity</a> in the <i>Amazon SES Developer Guide.</i> You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the <code>ListConfigurationSets</code> operation again, passing the <code>NextToken</code> parameter and the value of the NextToken element to retrieve additional results. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SESConfigurationSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The number of configuration sets to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token returned from a previous call to <code>ListConfigurationSets</code> to indicate the position of the configuration set in the configuration set list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The number of configuration sets to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token returned from a previous call to <code>ListConfigurationSets</code> to indicate the position of the configuration set in the configuration set list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleEmail.Model.ConfigurationSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ConfigurationSet objects. The service call response (type Amazon.SimpleEmail.Model.ListConfigurationSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SESConfigurationSetList.html&tocid=Get-SESConfigurationSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESIdentity</name> <description> <para>Invokes the ListIdentities operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESIdentity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status. You can execute this operation no more than once per second. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SESIdentity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IdentityType</name> <description> <para>The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.IdentityType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of identities per page. Possible values are 1-1000 inclusive. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token to use for pagination. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>IdentityType</name> <description> <para>The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.IdentityType</parameterValue> <type> <name>Amazon.SimpleEmail.IdentityType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of identities per page. Possible values are 1-1000 inclusive. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token to use for pagination. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.ListIdentitiesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SESIdentity.html&tocid=Get-SESIdentity</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-SESIdentity</code><remarks><para>Description</para><para>-----------</para><para>This command returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status.</para><para /><para /></remarks> </example> </examples> </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>Get-SESIdentityDkimAttribute</name> <description> <para>Invokes the GetIdentityDkimAttributes operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESIdentityDkimAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. This operation takes a list of identities as input and returns the following information for each: - Whether Easy DKIM signing is enabled or disabled. - A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address. - Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses. This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. For more information about creating DNS records using DKIM tokens, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Get-SESIdentityDkimAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>A list of one or more verified identities - email addresses, domains, or both. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>A list of one or more verified identities - email addresses, domains, or both. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.GetIdentityDkimAttributesResponse) 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-SESIdentityDkimAttribute.html&tocid=Get-SESIdentityDkimAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESIdentityMailFromDomainAttribute</name> <description> <para>Invokes the GetIdentityMailFromDomainAttributes operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESIdentityMailFromDomainAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains). This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time. </para> </description> <syntax> <syntaxItem> <name>Get-SESIdentityMailFromDomainAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>A list of one or more identities. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>A list of one or more identities. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.GetIdentityMailFromDomainAttributesResponse) 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-SESIdentityMailFromDomainAttribute.html&tocid=Get-SESIdentityMailFromDomainAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESIdentityNotificationAttribute</name> <description> <para>Invokes the GetIdentityNotificationAttributes operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESIdentityNotificationAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Get-SESIdentityNotificationAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.GetIdentityNotificationAttributesResponse) 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-SESIdentityNotificationAttribute.html&tocid=Get-SESIdentityNotificationAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESIdentityPolicy</name> <description> <para>Invokes the GetIdentityPolicies operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESIdentityPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESIdentityPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyName</name> <description> <para>A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use <code>ListIdentityPolicies</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Identity</name> <description> <para>The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. To successfully call this API, you must own the identity. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Identity</name> <description> <para>The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. To successfully call this API, you must own the identity. </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 (ByValue, )" position="1"> <name>PolicyName</name> <description> <para>A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use <code>ListIdentityPolicies</code>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.GetIdentityPoliciesResponse) 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-SESIdentityPolicy.html&tocid=Get-SESIdentityPolicy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESIdentityPolicyList</name> <description> <para>Invokes the ListIdentityPolicies operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESIdentityPolicyList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use <code>GetIdentityPolicies</code>. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESIdentityPolicyList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. To successfully call this API, you must own the identity. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. To successfully call this API, you must own the identity. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.ListIdentityPoliciesResponse) 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-SESIdentityPolicyList.html&tocid=Get-SESIdentityPolicyList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESIdentityVerificationAttribute</name> <description> <para>Invokes the GetIdentityVerificationAttributes operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESIdentityVerificationAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning. For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning. This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. </para> </description> <syntax> <syntaxItem> <name>Get-SESIdentityVerificationAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>A list of identities. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>A list of identities. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.GetIdentityVerificationAttributesResponse) 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-SESIdentityVerificationAttribute.html&tocid=Get-SESIdentityVerificationAttribute</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESReceiptFilterList</name> <description> <para>Invokes the ListReceiptFilters operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESReceiptFilterList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the IP address filters associated with your AWS account. For information about managing IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESReceiptFilterList</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.SimpleEmail.Model.ReceiptFilter</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ReceiptFilter objects. The service call response (type Amazon.SimpleEmail.Model.ListReceiptFiltersResponse) 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-SESReceiptFilterList.html&tocid=Get-SESReceiptFilterList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESReceiptRule</name> <description> <para>Invokes the DescribeReceiptRule operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESReceiptRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the details of the specified receipt rule. For information about setting up receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESReceiptRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>RuleName</name> <description> <para>The name of the receipt rule. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set that the receipt rule belongs to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>RuleName</name> <description> <para>The name of the receipt rule. </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>RuleSetName</name> <description> <para>The name of the receipt rule set that the receipt rule belongs to. </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.SimpleEmail.Model.ReceiptRule</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ReceiptRule object. The service call response (type Amazon.SimpleEmail.Model.DescribeReceiptRuleResponse) 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-SESReceiptRule.html&tocid=Get-SESReceiptRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESReceiptRuleSet</name> <description> <para>Invokes the DescribeReceiptRuleSet operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESReceiptRuleSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESReceiptRuleSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set to describe. </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.SimpleEmail.Model.DescribeReceiptRuleSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleEmail.Model.DescribeReceiptRuleSetResponse 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-SESReceiptRuleSet.html&tocid=Get-SESReceiptRuleSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESReceiptRuleSetList</name> <description> <para>Invokes the ListReceiptRuleSets operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESReceiptRuleSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a <code>NextToken</code> that you can provide to the next call to <code>ListReceiptRuleSets</code> to retrieve the additional entries. For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESReceiptRuleSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token returned from a previous call to <code>ListReceiptRuleSets</code> to indicate the position in the receipt rule set list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>A token returned from a previous call to <code>ListReceiptRuleSets</code> to indicate the position in the receipt rule set list. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleEmail.Model.ReceiptRuleSetMetadata</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ReceiptRuleSetMetadata objects. The service call response (type Amazon.SimpleEmail.Model.ListReceiptRuleSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SESReceiptRuleSetList.html&tocid=Get-SESReceiptRuleSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESSendQuota</name> <description> <para>Invokes the GetSendQuota operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESSendQuota</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Provides the sending limits for the Amazon SES account. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESSendQuota</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.SimpleEmail.Model.GetSendQuotaResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SimpleEmail.Model.GetSendQuotaResponse 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-SESSendQuota.html&tocid=Get-SESSendQuota</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-SESSendQuota</code><remarks><para>Description</para><para>-----------</para><para>This command returns the user's current sending limits.</para><para /><para /></remarks> </example> </examples> </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>Get-SESSendStatistic</name> <description> <para>Invokes the GetSendStatistics operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESSendStatistic</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Provides sending statistics for the Amazon SES account. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESSendStatistic</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.SimpleEmail.Model.SendDataPoint</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of SendDataPoint objects. The service call response (type Amazon.SimpleEmail.Model.GetSendStatisticsResponse) 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-SESSendStatistic.html&tocid=Get-SESSendStatistic</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-SESSendStatistic</code><remarks><para>Description</para><para>-----------</para><para>This command returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute interval.</para><para /><para /></remarks> </example> </examples> </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>Get-SESTemplate</name> <description> <para>Invokes the GetTemplate operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESTemplate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Get-SESTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the template you want to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the template you want to retrieve. </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.SimpleEmail.Model.Template</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Template object. The service call response (type Amazon.SimpleEmail.Model.GetTemplateResponse) 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-SESTemplate.html&tocid=Get-SESTemplate</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESTemplateList</name> <description> <para>Invokes the ListTemplates operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESTemplateList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the email templates present in your Amazon SES account. You can execute this operation no more than once per second. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SESTemplateList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token to use for pagination. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The token to use for pagination. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.SimpleEmail.Model.TemplateMetadata</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TemplateMetadata objects. The service call response (type Amazon.SimpleEmail.Model.ListTemplatesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SESTemplateList.html&tocid=Get-SESTemplateList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SESVerifiedEmailAddress</name> <description> <para>Invokes the ListVerifiedEmailAddresses operation against Amazon Simple Email Service.</para> </description> <verb>Get</verb> <noun>SESVerifiedEmailAddress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deprecated. Use the <code>ListIdentities</code> operation to list the email addresses and domains associated with your account. </para> </description> <syntax> <syntaxItem> <name>Get-SESVerifiedEmailAddress</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.SimpleEmail.Model.ListVerifiedEmailAddressesResponse) 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-SESVerifiedEmailAddress.html&tocid=Get-SESVerifiedEmailAddress</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>New-SESConfigurationSet</name> <description> <para>Invokes the CreateConfigurationSet operation against Amazon Simple Email Service.</para> </description> <verb>New</verb> <noun>SESConfigurationSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>New-SESConfigurationSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ConfigurationSet_Name</name> <description> <para>The name of the configuration set. The name must meet the following requirements: - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSet_Name parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ConfigurationSet_Name</name> <description> <para>The name of the configuration set. The name must meet the following requirements: - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSet_Name parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ConfigurationSet_Name parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.CreateConfigurationSetResponse) 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=New-SESConfigurationSet.html&tocid=New-SESConfigurationSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>New-SESConfigurationSetEventDestination</name> <description> <para>Invokes the CreateConfigurationSetEventDestination operation against Amazon Simple Email Service.</para> </description> <verb>New</verb> <noun>SESConfigurationSetEventDestination</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>New-SESConfigurationSetEventDestination</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set that the event destination should be associated with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KinesisFirehoseDestination_DeliveryStreamARN</name> <description> <para>The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchDestination_DimensionConfiguration</name> <description> <para>A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.CloudWatchDimensionConfiguration[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventDestination_Enabled</name> <description> <para>Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to <code>true</code> to enable publishing to this destination; set to <code>false</code> to prevent publishing to this destination. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KinesisFirehoseDestination_IAMRoleARN</name> <description> <para>The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventDestination_MatchingEventType</name> <description> <para>The type of email sending events to publish to the event destination. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventDestination_Name</name> <description> <para>The name of the event destination. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain less than 64 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SNSDestination_TopicARN</name> <description> <para>The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <a href="http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchDestination_DimensionConfiguration</name> <description> <para>A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.CloudWatchDimensionConfiguration[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.CloudWatchDimensionConfiguration[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set that the event destination should be associated with. </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="False" position="Named"> <name>EventDestination_Enabled</name> <description> <para>Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to <code>true</code> to enable publishing to this destination; set to <code>false</code> to prevent publishing to this destination. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventDestination_MatchingEventType</name> <description> <para>The type of email sending events to publish to the event destination. </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="False" position="Named"> <name>EventDestination_Name</name> <description> <para>The name of the event destination. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain less than 64 characters. </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="False" 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="False" position="Named"> <name>KinesisFirehoseDestination_DeliveryStreamARN</name> <description> <para>The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to. </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="False" position="Named"> <name>KinesisFirehoseDestination_IAMRoleARN</name> <description> <para>The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>SNSDestination_TopicARN</name> <description> <para>The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <a href="http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ConfigurationSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.CreateConfigurationSetEventDestinationResponse) 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=New-SESConfigurationSetEventDestination.html&tocid=New-SESConfigurationSetEventDestination</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>New-SESConfigurationSetTrackingOption</name> <description> <para>Invokes the CreateConfigurationSetTrackingOptions operation against Amazon Simple Email Service.</para> </description> <verb>New</verb> <noun>SESConfigurationSetTrackingOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using configuration sets, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-SESConfigurationSetTrackingOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TrackingOption</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.TrackingOptions</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set that the tracking options should be associated with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TrackingOption parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set that the tracking options should be associated with. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TrackingOption parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>TrackingOption</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.TrackingOptions</parameterValue> <type> <name>Amazon.SimpleEmail.Model.TrackingOptions</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.SimpleEmail.Model.TrackingOptions</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TrackingOption parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.CreateConfigurationSetTrackingOptionsResponse) 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=New-SESConfigurationSetTrackingOption.html&tocid=New-SESConfigurationSetTrackingOption</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>New-SESReceiptFilter</name> <description> <para>Invokes the CreateReceiptFilter operation against Amazon Simple Email Service.</para> </description> <verb>New</verb> <noun>SESReceiptFilter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new IP address filter. For information about setting up IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>New-SESReceiptFilter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IpFilter_Cidr</name> <description> <para>A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see <a href="https://tools.ietf.org/html/rfc2317">RFC 2317</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_Name</name> <description> <para>The name of the IP address filter. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IpFilter_Policy</name> <description> <para>Indicates whether to block or allow incoming mail from the specified IP addresses. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.ReceiptFilterPolicy</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_Name</name> <description> <para>The name of the IP address filter. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </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="False" 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="False" position="Named"> <name>IpFilter_Cidr</name> <description> <para>A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see <a href="https://tools.ietf.org/html/rfc2317">RFC 2317</a>. </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="False" position="Named"> <name>IpFilter_Policy</name> <description> <para>Indicates whether to block or allow incoming mail from the specified IP addresses. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.ReceiptFilterPolicy</parameterValue> <type> <name>Amazon.SimpleEmail.ReceiptFilterPolicy</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.SimpleEmail.Model.CreateReceiptFilterResponse) 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=New-SESReceiptFilter.html&tocid=New-SESReceiptFilter</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>New-SESReceiptRule</name> <description> <para>Invokes the CreateReceiptRule operation against Amazon Simple Email Service.</para> </description> <verb>New</verb> <noun>SESReceiptRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a receipt rule. For information about setting up receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>New-SESReceiptRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Action</name> <description> <para>An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.ReceiptAction[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>After</name> <description> <para>The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Enabled</name> <description> <para>If <code>true</code>, the receipt rule is active. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Name</name> <description> <para>The name of the receipt rule. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Recipient</name> <description> <para>The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the rule set that the receipt rule will be added to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_ScanEnabled</name> <description> <para>If <code>true</code>, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_TlsPolicy</name> <description> <para>Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The default is <code>Optional</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.TlsPolicy</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>After</name> <description> <para>The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list. </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="False" 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="False" position="Named"> <name>Rule_Action</name> <description> <para>An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.ReceiptAction[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.ReceiptAction[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Enabled</name> <description> <para>If <code>true</code>, the receipt rule is active. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Name</name> <description> <para>The name of the receipt rule. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </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="False" position="Named"> <name>Rule_Recipient</name> <description> <para>The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains. </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="False" position="Named"> <name>Rule_ScanEnabled</name> <description> <para>If <code>true</code>, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_TlsPolicy</name> <description> <para>Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The default is <code>Optional</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.TlsPolicy</parameterValue> <type> <name>Amazon.SimpleEmail.TlsPolicy</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the rule set that the receipt rule will be added to. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.SimpleEmail.Model.CreateReceiptRuleResponse) 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=New-SESReceiptRule.html&tocid=New-SESReceiptRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>New-SESReceiptRuleSet</name> <description> <para>Invokes the CreateReceiptRuleSet operation against Amazon Simple Email Service.</para> </description> <verb>New</verb> <noun>SESReceiptRuleSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an empty receipt rule set. For information about setting up receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>New-SESReceiptRuleSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>RuleSetName</name> <description> <para>The name of the rule set to create. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>RuleSetName</name> <description> <para>The name of the rule set to create. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the RuleSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.CreateReceiptRuleSetResponse) 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=New-SESReceiptRuleSet.html&tocid=New-SESReceiptRuleSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>New-SESTemplate</name> <description> <para>Invokes the CreateTemplate operation against Amazon Simple Email Service.</para> </description> <verb>New</verb> <noun>SESTemplate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>New-SESTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Template</name> <description> <para>The content of the email, composed of a subject line, an HTML part, and a text-only part. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.Template</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Template parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Template parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>Template</name> <description> <para>The content of the email, composed of a subject line, an HTML part, and a text-only part. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.Template</parameterValue> <type> <name>Amazon.SimpleEmail.Model.Template</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.SimpleEmail.Model.Template</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Template parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.CreateTemplateResponse) 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=New-SESTemplate.html&tocid=New-SESTemplate</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESConfigurationSet</name> <description> <para>Invokes the DeleteConfigurationSet operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESConfigurationSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Remove-SESConfigurationSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to delete. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ConfigurationSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteConfigurationSetResponse) 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-SESConfigurationSet.html&tocid=Remove-SESConfigurationSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESConfigurationSetEventDestination</name> <description> <para>Invokes the DeleteConfigurationSetEventDestination operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESConfigurationSetEventDestination</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Remove-SESConfigurationSetEventDestination</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EventDestinationName</name> <description> <para>The name of the event destination to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set from which to delete the event destination. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EventDestinationName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set from which to delete the event destination. </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 (ByValue, ByPropertyName)" position="1"> <name>EventDestinationName</name> <description> <para>The name of the event destination to delete. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EventDestinationName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the EventDestinationName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteConfigurationSetEventDestinationResponse) 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-SESConfigurationSetEventDestination.html&tocid=Remove-SESConfigurationSetEventDestination</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESConfigurationSetTrackingOption</name> <description> <para>Invokes the DeleteConfigurationSetTrackingOptions operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESConfigurationSetTrackingOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using configuration sets, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer Guide</a>. Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains. </para> </description> <syntax> <syntaxItem> <name>Remove-SESConfigurationSetTrackingOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set from which you want to delete the tracking options. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set from which you want to delete the tracking options. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ConfigurationSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteConfigurationSetTrackingOptionsResponse) 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-SESConfigurationSetTrackingOption.html&tocid=Remove-SESConfigurationSetTrackingOption</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESIdentity</name> <description> <para>Invokes the DeleteIdentity operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESIdentity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Remove-SESIdentity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity to be removed from the list of identities for the AWS Account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity to be removed from the list of identities for the AWS Account. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Identity parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteIdentityResponse) 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-SESIdentity.html&tocid=Remove-SESIdentity</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESIdentityPolicy</name> <description> <para>Invokes the DeleteIdentityPolicy operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESIdentityPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Remove-SESIdentityPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyName</name> <description> <para>The name of the policy to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Identity</name> <description> <para>The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. To successfully call this API, you must own the identity. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>Identity</name> <description> <para>The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. To successfully call this API, you must own the identity. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>PolicyName</name> <description> <para>The name of the policy to be deleted. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PolicyName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteIdentityPolicyResponse) 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-SESIdentityPolicy.html&tocid=Remove-SESIdentityPolicy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESReceiptFilter</name> <description> <para>Invokes the DeleteReceiptFilter operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESReceiptFilter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified IP address filter. For information about managing IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Remove-SESReceiptFilter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FilterName</name> <description> <para>The name of the IP address filter to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the FilterName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FilterName</name> <description> <para>The name of the IP address filter to delete. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the FilterName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the FilterName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteReceiptFilterResponse) 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-SESReceiptFilter.html&tocid=Remove-SESReceiptFilter</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESReceiptRule</name> <description> <para>Invokes the DeleteReceiptRule operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESReceiptRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified receipt rule. For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Remove-SESReceiptRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleName</name> <description> <para>The name of the receipt rule to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set that contains the receipt rule to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>RuleName</name> <description> <para>The name of the receipt rule to delete. </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>RuleSetName</name> <description> <para>The name of the receipt rule set that contains the receipt rule to delete. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.SimpleEmail.Model.DeleteReceiptRuleResponse) 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-SESReceiptRule.html&tocid=Remove-SESReceiptRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESReceiptRuleSet</name> <description> <para>Invokes the DeleteReceiptRuleSet operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESReceiptRuleSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Remove-SESReceiptRuleSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the RuleSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteReceiptRuleSetResponse) 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-SESReceiptRuleSet.html&tocid=Remove-SESReceiptRuleSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESTemplate</name> <description> <para>Invokes the DeleteTemplate operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESTemplate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an email template. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Remove-SESTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the template to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TemplateName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TemplateName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>TemplateName</name> <description> <para>The name of the template to be deleted. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TemplateName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteTemplateResponse) 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-SESTemplate.html&tocid=Remove-SESTemplate</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESVerifiedEmailAddress</name> <description> <para>Invokes the DeleteVerifiedEmailAddress operation against Amazon Simple Email Service.</para> </description> <verb>Remove</verb> <noun>SESVerifiedEmailAddress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deprecated. Use the <code>DeleteIdentity</code> operation to delete email addresses and domains. </para> </description> <syntax> <syntaxItem> <name>Remove-SESVerifiedEmailAddress</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EmailAddress</name> <description> <para>An email address to be removed from the list of verified addresses. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EmailAddress</name> <description> <para>An email address to be removed from the list of verified addresses. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the EmailAddress parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.DeleteVerifiedEmailAddressResponse) 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-SESVerifiedEmailAddress.html&tocid=Remove-SESVerifiedEmailAddress</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESBounce</name> <description> <para>Invokes the SendBounce operation against Amazon Simple Email Service.</para> </description> <verb>Send</verb> <noun>SESBounce</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. You cannot use this API to send generic bounces for mail that was not received by Amazon SES. For information about receiving email through Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Send-SESBounce</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>BouncedRecipientInfoList</name> <description> <para>A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one <code>BouncedRecipientInfo</code> in the list. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.BouncedRecipientInfo[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageDsn_ArrivalDate</name> <description> <para>When the message was received by the reporting mail transfer agent (MTA), in <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a> date-time format. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BounceSender</name> <description> <para>The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BounceSenderArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Explanation</name> <description> <para>Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageDsn_ExtensionField</name> <description> <para>Additional X-headers to include in the DSN. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.ExtensionField[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OriginalMessageId</name> <description> <para>The message ID of the message to be bounced. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageDsn_ReportingMta</name> <description> <para>The reporting MTA that attempted to deliver the message, formatted as specified in <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a> (<code>mta-name-type; mta-name</code>). The default value is <code>dns; inbound-smtp.[region].amazonaws.com</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>BouncedRecipientInfoList</name> <description> <para>A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one <code>BouncedRecipientInfo</code> in the list. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.BouncedRecipientInfo[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.BouncedRecipientInfo[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BounceSender</name> <description> <para>The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES. </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="False" position="Named"> <name>BounceSenderArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>Explanation</name> <description> <para>Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient 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="False" 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="False" position="Named"> <name>MessageDsn_ArrivalDate</name> <description> <para>When the message was received by the reporting mail transfer agent (MTA), in <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a> date-time format. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageDsn_ExtensionField</name> <description> <para>Additional X-headers to include in the DSN. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.ExtensionField[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.ExtensionField[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageDsn_ReportingMta</name> <description> <para>The reporting MTA that attempted to deliver the message, formatted as specified in <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a> (<code>mta-name-type; mta-name</code>). The default value is <code>dns; inbound-smtp.[region].amazonaws.com</code>. </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="False" position="Named"> <name>OriginalMessageId</name> <description> <para>The message ID of the message to be bounced. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleEmail.Model.SendBounceResponse) 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=Send-SESBounce.html&tocid=Send-SESBounce</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESBulkTemplatedEmail</name> <description> <para>Invokes the SendBulkTemplatedEmail operation against Amazon Simple Email Service.</para> </description> <verb>Send</verb> <noun>SESBulkTemplatedEmail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Composes an email message to multiple destinations. The message body is created using an email template. In order to send email using the <code>SendBulkTemplatedEmail</code> operation, your call to the API must meet the following requirements: - The call must refer to an existing email template. You can create email templates using the <a>CreateTemplate</a> operation. - The message must be sent from a verified email address or domain. - If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> - The total size of the message, including attachments, must be less than 10 MB. - Each <code>Destination</code> parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid. </para> </description> <syntax> <syntaxItem> <name>Send-SESBulkTemplatedEmail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to use when you send an email using <code>SendBulkTemplatedEmail</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultTag</name> <description> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using <code>SendBulkTemplatedEmail</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.MessageTag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultTemplateData</name> <description> <para>A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available. The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Destination</name> <description> <para>One or more <code>Destination</code> objects. All of the recipients in a <code>Destination</code> will receive the same version of the email. You can specify up to 50 <code>Destination</code> objects within a <code>Destinations</code> array. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.BulkEmailDestination[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReplyToAddress</name> <description> <para>The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnPath</name> <description> <para>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnPathArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Source</name> <description> <para>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Template</name> <description> <para>The template to use when sending this email. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TemplateArn</name> <description> <para>The ARN of the template to use when sending this email. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to use when you send an email using <code>SendBulkTemplatedEmail</code>. </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="False" position="Named"> <name>DefaultTag</name> <description> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using <code>SendBulkTemplatedEmail</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.MessageTag[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.MessageTag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultTemplateData</name> <description> <para>A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available. The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. </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="False" position="Named"> <name>Destination</name> <description> <para>One or more <code>Destination</code> objects. All of the recipients in a <code>Destination</code> will receive the same version of the email. You can specify up to 50 <code>Destination</code> objects within a <code>Destinations</code> array. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.BulkEmailDestination[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.BulkEmailDestination[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>ReplyToAddress</name> <description> <para>The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. </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="False" position="Named"> <name>ReturnPath</name> <description> <para>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </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="False" position="Named"> <name>ReturnPathArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>Source</name> <description> <para>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>. </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="False" position="Named"> <name>SourceArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>Template</name> <description> <para>The template to use when sending this email. </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="False" position="Named"> <name>TemplateArn</name> <description> <para>The ARN of the template to use when sending this email. </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.SimpleEmail.Model.BulkEmailDestinationStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of BulkEmailDestinationStatus objects. The service call response (type Amazon.SimpleEmail.Model.SendBulkTemplatedEmailResponse) 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=Send-SESBulkTemplatedEmail.html&tocid=Send-SESBulkTemplatedEmail</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESEmail</name> <description> <para>Invokes the SendEmail operation against Amazon Simple Email Service.</para> </description> <verb>Send</verb> <noun>SESEmail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Composes an email message and immediately queues it for sending. In order to send email using the <code>SendEmail</code> operation, your message must meet the following requirements: - The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error. - If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> - The total size of the message, including attachments, must be smaller than 10 MB. - The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid. - The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the <code>SendEmail</code> operation several times to send the message to each group. <important><para> For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your <i>sending quota</i>). For more information about sending quotas in Amazon SES, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Managing Your Amazon SES Sending Limits</a> in the <i>Amazon SES Developer Guide.</i></para></important> </para> </description> <syntax> <syntaxItem> <name>Send-SESEmail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Source</name> <description> <para>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Destination_ToAddress</name> <description> <para>The To: field(s) of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Destination_BccAddress</name> <description> <para>The BCC: field(s) of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Destination_CcAddress</name> <description> <para>The CC: field(s) of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Html_Charset</name> <description> <para>The character set of the content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Text_Charset</name> <description> <para>The character set of the content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Charset</name> <description> <para>The character set of the content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to use when you send an email using <code>SendEmail</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Html_Data</name> <description> <para>The textual data of the content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Text_Data</name> <description> <para>The textual data of the content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject_Data</name> <description> <para>The textual data of the content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReplyToAddress</name> <description> <para>The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnPath</name> <description> <para>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnPathArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send using <code>SendEmail</code>. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.MessageTag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to use when you send an email using <code>SendEmail</code>. </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="False" position="Named"> <name>Destination_BccAddress</name> <description> <para>The BCC: field(s) of the message. </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="False" position="Named"> <name>Destination_CcAddress</name> <description> <para>The CC: field(s) of the message. </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="False" position="2"> <name>Destination_ToAddress</name> <description> <para>The To: field(s) of the message. </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="False" 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="False" position="Named"> <name>Html_Charset</name> <description> <para>The character set of the content. </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="False" position="Named"> <name>Html_Data</name> <description> <para>The textual data of the content. </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="False" position="Named"> <name>ReplyToAddress</name> <description> <para>The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. </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="False" position="Named"> <name>ReturnPath</name> <description> <para>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </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="False" position="Named"> <name>ReturnPathArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </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 (ByValue, )" position="1"> <name>Source</name> <description> <para>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>. </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="False" position="Named"> <name>SourceArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>Subject_Charset</name> <description> <para>The character set of the content. </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="False" position="Named"> <name>Subject_Data</name> <description> <para>The textual data of the content. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send using <code>SendEmail</code>. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.MessageTag[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.MessageTag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Text_Charset</name> <description> <para>The character set of the content. </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="False" position="Named"> <name>Text_Data</name> <description> <para>The textual data of the content. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleEmail.Model.SendEmailResponse) 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=Send-SESEmail.html&tocid=Send-SESEmail</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESRawEmail</name> <description> <para>Invokes the SendRawEmail operation against Amazon Simple Email Service.</para> </description> <verb>Send</verb> <noun>SESRawEmail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Composes an email message and immediately queues it for sending. When calling this operation, you may specify the message headers as well as the content. The <code>SendRawEmail</code> operation is particularly useful for sending multipart MIME emails (such as those that contain both a plain-text and an HTML version). In order to send email using the <code>SendRawEmail</code> operation, your message must meet the following requirements: - The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error. - If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> - The total size of the message, including attachments, must be smaller than 10 MB. - The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid. - The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the <code>SendRawEmail</code> operation several times to send the message to each group. <important><para> For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your <i>sending quota</i>). For more information about sending quotas in Amazon SES, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Managing Your Amazon SES Sending Limits</a> in the <i>Amazon SES Developer Guide.</i></para></important> Additionally, keep the following considerations in mind when using the <code>SendRawEmail</code> operation: - Although you can customize the message headers when using the <code>SendRawEmail</code> operation, Amazon SES will automatically apply its own <code>Message-ID</code> and <code>Date</code> headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides. - If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>, and/or <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw email: - <code>X-SES-SOURCE-ARN</code> - <code>X-SES-FROM-ARN</code> - <code>X-SES-RETURN-PATH-ARN</code> <important><para> Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email. </para></important> For most common sending authorization scenarios, we recommend that you specify the <code>SourceIdentityArn</code> parameter and not the <code>FromIdentityArn</code> or <code>ReturnPathIdentityArn</code> parameters. If you only specify the <code>SourceIdentityArn</code> parameter, Amazon SES will set the From and Return Path addresses to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Using Sending Authorization with Amazon SES</a> in the <i>Amazon SES Developer Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Send-SESRawEmail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Source</name> <description> <para>The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.) By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>. If you specify the <code>Source</code> parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Destination</name> <description> <para>A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to use when you send an email using <code>SendRawEmail</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RawMessage_Data</name> <description> <para>The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding. The To:, CC:, and BCC: headers in the raw message can contain a group list. If you are using <code>SendRawEmail</code> with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for <code>SendRawEmail</code>. <important><para>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</para></important> For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.IO.MemoryStream</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FromArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email. Instead of using this parameter, you can use the X-header <code>X-SES-FROM-ARN</code> in the raw message of the email. If you use both the <code>FromArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>FromArn</code> parameter. For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnPathArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>. Instead of using this parameter, you can use the X-header <code>X-SES-RETURN-PATH-ARN</code> in the raw message of the email. If you use both the <code>ReturnPathArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>ReturnPathArn</code> parameter. For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>. Instead of using this parameter, you can use the X-header <code>X-SES-SOURCE-ARN</code> in the raw message of the email. If you use both the <code>SourceArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>SourceArn</code> parameter. For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send using <code>SendRawEmail</code>. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.MessageTag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to use when you send an email using <code>SendRawEmail</code>. </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="False" position="2"> <name>Destination</name> <description> <para>A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. </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="False" 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="False" position="Named"> <name>FromArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email. Instead of using this parameter, you can use the X-header <code>X-SES-FROM-ARN</code> in the raw message of the email. If you use both the <code>FromArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>FromArn</code> parameter. For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>RawMessage_Data</name> <description> <para>The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding. The To:, CC:, and BCC: headers in the raw message can contain a group list. If you are using <code>SendRawEmail</code> with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for <code>SendRawEmail</code>. <important><para>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</para></important> For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.IO.MemoryStream</parameterValue> <type> <name>System.IO.MemoryStream</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnPathArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>. Instead of using this parameter, you can use the X-header <code>X-SES-RETURN-PATH-ARN</code> in the raw message of the email. If you use both the <code>ReturnPathArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>ReturnPathArn</code> parameter. For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </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 (ByValue, )" position="1"> <name>Source</name> <description> <para>The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.) By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>. If you specify the <code>Source</code> parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message. </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="False" position="Named"> <name>SourceArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>. Instead of using this parameter, you can use the X-header <code>X-SES-SOURCE-ARN</code> in the raw message of the email. If you use both the <code>SourceArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>SourceArn</code> parameter. For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send using <code>SendRawEmail</code>. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.MessageTag[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.MessageTag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleEmail.Model.SendRawEmailResponse) 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=Send-SESRawEmail.html&tocid=Send-SESRawEmail</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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-SESTemplatedEmail</name> <description> <para>Invokes the SendTemplatedEmail operation against Amazon Simple Email Service.</para> </description> <verb>Send</verb> <noun>SESTemplatedEmail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Composes an email message using an email template and immediately queues it for sending. In order to send email using the <code>SendTemplatedEmail</code> operation, your call to the API must meet the following requirements: - The call must refer to an existing email template. You can create email templates using the <a>CreateTemplate</a> operation. - The message must be sent from a verified email address or domain. - If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> - The total size of the message, including attachments, must be less than 10 MB. - Calls to the <code>SendTemplatedEmail</code> operation may only include one <code>Destination</code> parameter. A destination is a set of recipients who will receive the same version of the email. The <code>Destination</code> parameter can include up to 50 recipients, across the To:, CC: and BCC: fields. - The <code>Destination</code> parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid. </para> </description> <syntax> <syntaxItem> <name>Send-SESTemplatedEmail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateData</name> <description> <para>A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Destination_BccAddress</name> <description> <para>The BCC: field(s) of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Destination_CcAddress</name> <description> <para>The CC: field(s) of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to use when you send an email using <code>SendTemplatedEmail</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReplyToAddress</name> <description> <para>The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnPath</name> <description> <para>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnPathArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Source</name> <description> <para>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send using <code>SendTemplatedEmail</code>. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.MessageTag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Template</name> <description> <para>The template to use when sending this email. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TemplateArn</name> <description> <para>The ARN of the template to use when sending this email. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Destination_ToAddress</name> <description> <para>The To: field(s) of the message. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set to use when you send an email using <code>SendTemplatedEmail</code>. </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="False" position="Named"> <name>Destination_BccAddress</name> <description> <para>The BCC: field(s) of the message. </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="False" position="Named"> <name>Destination_CcAddress</name> <description> <para>The CC: field(s) of the message. </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="False" position="Named"> <name>Destination_ToAddress</name> <description> <para>The To: field(s) of the message. </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="False" 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="False" position="Named"> <name>ReplyToAddress</name> <description> <para>The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. </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="False" position="Named"> <name>ReturnPath</name> <description> <para>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </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="False" position="Named"> <name>ReturnPathArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>Source</name> <description> <para>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>. If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="https://tools.ietf.org/html/rfc2047">RFC 2047</a>. </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="False" position="Named"> <name>SourceArn</name> <description> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter. For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tags, in the form of name/value pairs, to apply to an email that you send using <code>SendTemplatedEmail</code>. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.MessageTag[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.MessageTag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Template</name> <description> <para>The template to use when sending this email. </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="False" position="Named"> <name>TemplateArn</name> <description> <para>The ARN of the template to use when sending this email. </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 (ByValue, )" position="1"> <name>TemplateData</name> <description> <para>A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleEmail.Model.SendTemplatedEmailResponse) 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=Send-SESTemplatedEmail.html&tocid=Send-SESTemplatedEmail</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Set-SESActiveReceiptRuleSet</name> <description> <para>Invokes the SetActiveReceiptRuleSet operation against Amazon Simple Email Service.</para> </description> <verb>Set</verb> <noun>SESActiveReceiptRuleSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null. For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Set-SESActiveReceiptRuleSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set to make active. Setting this value to null disables all email receiving. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set to make active. Setting this value to null disables all email receiving. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the RuleSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.SetActiveReceiptRuleSetResponse) 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=Set-SESActiveReceiptRuleSet.html&tocid=Set-SESActiveReceiptRuleSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Set-SESIdentityDkimEnabled</name> <description> <para>Invokes the SetIdentityDkimEnabled operation against Amazon Simple Email Service.</para> </description> <verb>Set</verb> <noun>SESIdentityDkimEnabled</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables or disables Easy DKIM signing of email sent from an identity: - If Easy DKIM signing is enabled for a domain name identity (such as <code>example.com</code>), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (for example, <code>user@example.com</code>). - If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address. For email addresses (for example, <code>user@example.com</code>), you can only enable Easy DKIM signing if the corresponding domain (in this case, <code>example.com</code>) has been set up for Easy DKIM using the AWS Console or the <code>VerifyDomainDkim</code> operation. You can execute this operation no more than once per second. For more information about Easy DKIM signing, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Set-SESIdentityDkimEnabled</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity for which DKIM signing should be enabled or disabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DkimEnabled</name> <description> <para>Sets whether DKIM signing is enabled for an identity. Set to <code>true</code> to enable DKIM signing for this identity; <code>false</code> to disable it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DkimEnabled</name> <description> <para>Sets whether DKIM signing is enabled for an identity. Set to <code>true</code> to enable DKIM signing for this identity; <code>false</code> to disable it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity for which DKIM signing should be enabled or disabled. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Identity parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.SetIdentityDkimEnabledResponse) 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=Set-SESIdentityDkimEnabled.html&tocid=Set-SESIdentityDkimEnabled</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Set-SESIdentityFeedbackForwardingEnabled</name> <description> <para>Invokes the SetIdentityFeedbackForwardingEnabled operation against Amazon Simple Email Service.</para> </description> <verb>Set</verb> <noun>SESIdentityFeedbackForwardingEnabled</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Set-SESIdentityFeedbackForwardingEnabled</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity for which to set bounce and complaint notification forwarding. Examples: <code>user@example.com</code>, <code>example.com</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ForwardingEnabled</name> <description> <para>Sets whether Amazon SES will forward bounce and complaint notifications as email. <code>true</code> specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. <code>false</code> specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to <code>false</code> when Amazon SNS topics are set for both <code>Bounce</code> and <code>Complaint</code> notification types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>ForwardingEnabled</name> <description> <para>Sets whether Amazon SES will forward bounce and complaint notifications as email. <code>true</code> specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. <code>false</code> specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to <code>false</code> when Amazon SNS topics are set for both <code>Bounce</code> and <code>Complaint</code> notification types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity for which to set bounce and complaint notification forwarding. Examples: <code>user@example.com</code>, <code>example.com</code>. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Identity parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.SetIdentityFeedbackForwardingEnabledResponse) 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=Set-SESIdentityFeedbackForwardingEnabled.html&tocid=Set-SESIdentityFeedbackForwardingEnabled</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Set-SESIdentityHeadersInNotificationsEnabled</name> <description> <para>Invokes the SetIdentityHeadersInNotificationsEnabled operation against Amazon Simple Email Service.</para> </description> <verb>Set</verb> <noun>SESIdentityHeadersInNotificationsEnabled</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type. You can execute this operation no more than once per second. For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Set-SESIdentityHeadersInNotificationsEnabled</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity for which to enable or disable headers in notifications. Examples: <code>user@example.com</code>, <code>example.com</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para>Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of <code>true</code> specifies that Amazon SES will include headers in notifications, and a value of <code>false</code> specifies that Amazon SES will not include headers in notifications. This value can only be set when <code>NotificationType</code> is already set to use a particular Amazon SNS topic. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationType</name> <description> <para>The notification type for which to enable or disable headers in notifications. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.NotificationType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para>Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of <code>true</code> specifies that Amazon SES will include headers in notifications, and a value of <code>false</code> specifies that Amazon SES will not include headers in notifications. This value can only be set when <code>NotificationType</code> is already set to use a particular Amazon SNS topic. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity for which to enable or disable headers in notifications. Examples: <code>user@example.com</code>, <code>example.com</code>. </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="False" position="Named"> <name>NotificationType</name> <description> <para>The notification type for which to enable or disable headers in notifications. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.NotificationType</parameterValue> <type> <name>Amazon.SimpleEmail.NotificationType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Identity parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.SetIdentityHeadersInNotificationsEnabledResponse) 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=Set-SESIdentityHeadersInNotificationsEnabled.html&tocid=Set-SESIdentityHeadersInNotificationsEnabled</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Set-SESIdentityMailFromDomain</name> <description> <para>Invokes the SetIdentityMailFromDomain operation against Amazon Simple Email Service.</para> </description> <verb>Set</verb> <noun>SESIdentityMailFromDomain</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). <important><para> To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html">Amazon SES Developer Guide</a>. </para></important> You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Set-SESIdentityMailFromDomain</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The verified identity for which you want to enable or disable the specified custom MAIL FROM domain. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>MailFromDomain</name> <description> <para>The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html">Amazon SES Developer Guide</a>), and 3) not be used to receive emails. A value of <code>null</code> disables the custom MAIL FROM setting for the identity. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>BehaviorOnMXFailure</name> <description> <para>The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose <code>UseDefaultValue</code>, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose <code>RejectMessage</code>, Amazon SES will return a <code>MailFromDomainNotVerified</code> error and not send the email. The action specified in <code>BehaviorOnMXFailure</code> is taken when the custom MAIL FROM domain setup is in the <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code> states. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.BehaviorOnMXFailure</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>BehaviorOnMXFailure</name> <description> <para>The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose <code>UseDefaultValue</code>, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose <code>RejectMessage</code>, Amazon SES will return a <code>MailFromDomainNotVerified</code> error and not send the email. The action specified in <code>BehaviorOnMXFailure</code> is taken when the custom MAIL FROM domain setup is in the <code>Pending</code>, <code>Failed</code>, and <code>TemporaryFailure</code> states. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.BehaviorOnMXFailure</parameterValue> <type> <name>Amazon.SimpleEmail.BehaviorOnMXFailure</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The verified identity for which you want to enable or disable the specified custom MAIL FROM domain. </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="False" position="2"> <name>MailFromDomain</name> <description> <para>The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html">Amazon SES Developer Guide</a>), and 3) not be used to receive emails. A value of <code>null</code> disables the custom MAIL FROM setting for the identity. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Identity parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.SetIdentityMailFromDomainResponse) 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=Set-SESIdentityMailFromDomain.html&tocid=Set-SESIdentityMailFromDomain</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Set-SESIdentityNotificationTopic</name> <description> <para>Invokes the SetIdentityNotificationTopic operation against Amazon Simple Email Service.</para> </description> <verb>Set</verb> <noun>SESIdentityNotificationTopic</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the <code>Source</code>. Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see <code>SetIdentityFeedbackForwardingEnabled</code>. You can execute this operation no more than once per second. For more information about feedback notification, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Set-SESIdentityNotificationTopic</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>NotificationType</name> <description> <para>The type of notifications that will be published to the specified Amazon SNS topic. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.NotificationType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SnsTopic</name> <description> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, <code>SnsTopic</code> is cleared and publishing is disabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Identity</name> <description> <para>The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. </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="False" position="2"> <name>NotificationType</name> <description> <para>The type of notifications that will be published to the specified Amazon SNS topic. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.NotificationType</parameterValue> <type> <name>Amazon.SimpleEmail.NotificationType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </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="False" position="3"> <name>SnsTopic</name> <description> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, <code>SnsTopic</code> is cleared and publishing is disabled. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Identity parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.SetIdentityNotificationTopicResponse) 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=Set-SESIdentityNotificationTopic.html&tocid=Set-SESIdentityNotificationTopic</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Set-SESReceiptRulePosition</name> <description> <para>Invokes the SetReceiptRulePosition operation against Amazon Simple Email Service.</para> </description> <verb>Set</verb> <noun>SESReceiptRulePosition</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Set-SESReceiptRulePosition</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>After</name> <description> <para>The name of the receipt rule after which to place the specified receipt rule. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleName</name> <description> <para>The name of the receipt rule to reposition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set that contains the receipt rule to reposition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>After</name> <description> <para>The name of the receipt rule after which to place the specified receipt rule. </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="False" 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>RuleName</name> <description> <para>The name of the receipt rule to reposition. </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>RuleSetName</name> <description> <para>The name of the receipt rule set that contains the receipt rule to reposition. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.SimpleEmail.Model.SetReceiptRulePositionResponse) 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=Set-SESReceiptRulePosition.html&tocid=Set-SESReceiptRulePosition</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Set-SESReceiptRuleSetOrder</name> <description> <para>Invokes the ReorderReceiptRuleSet operation against Amazon Simple Email Service.</para> </description> <verb>Set</verb> <noun>SESReceiptRuleSetOrder</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules. For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Set-SESReceiptRuleSetOrder</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>RuleName</name> <description> <para>A list of the specified receipt rule set's receipt rules in the order that you want to put them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set to reorder. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>RuleName</name> <description> <para>A list of the specified receipt rule set's receipt rules in the order that you want to put them. </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>RuleSetName</name> <description> <para>The name of the receipt rule set to reorder. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the RuleName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.ReorderReceiptRuleSetResponse) 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=Set-SESReceiptRuleSetOrder.html&tocid=Set-SESReceiptRuleSetOrder</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Test-SESRenderTemplate</name> <description> <para>Invokes the TestRenderTemplate operation against Amazon Simple Email Service.</para> </description> <verb>Test</verb> <noun>SESRenderTemplate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Test-SESRenderTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateData</name> <description> <para>A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TemplateName</name> <description> <para>The name of the template that you want to render. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TemplateData</name> <description> <para>A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. </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="False" position="Named"> <name>TemplateName</name> <description> <para>The name of the template that you want to render. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SimpleEmail.Model.TestRenderTemplateResponse) 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=Test-SESRenderTemplate.html&tocid=Test-SESRenderTemplate</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Update-SESConfigurationSetEventDestination</name> <description> <para>Invokes the UpdateConfigurationSetEventDestination operation against Amazon Simple Email Service.</para> </description> <verb>Update</verb> <noun>SESConfigurationSetEventDestination</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Monitoring Your Amazon SES Sending Activity</a> in the <i>Amazon SES Developer Guide.</i> When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Update-SESConfigurationSetEventDestination</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set that contains the event destination that you want to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KinesisFirehoseDestination_DeliveryStreamARN</name> <description> <para>The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchDestination_DimensionConfiguration</name> <description> <para>A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.CloudWatchDimensionConfiguration[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventDestination_Enabled</name> <description> <para>Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to <code>true</code> to enable publishing to this destination; set to <code>false</code> to prevent publishing to this destination. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KinesisFirehoseDestination_IAMRoleARN</name> <description> <para>The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventDestination_MatchingEventType</name> <description> <para>The type of email sending events to publish to the event destination. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventDestination_Name</name> <description> <para>The name of the event destination. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain less than 64 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SNSDestination_TopicARN</name> <description> <para>The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <a href="http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchDestination_DimensionConfiguration</name> <description> <para>A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.CloudWatchDimensionConfiguration[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.CloudWatchDimensionConfiguration[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set that contains the event destination that you want to update. </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="False" position="Named"> <name>EventDestination_Enabled</name> <description> <para>Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to <code>true</code> to enable publishing to this destination; set to <code>false</code> to prevent publishing to this destination. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventDestination_MatchingEventType</name> <description> <para>The type of email sending events to publish to the event destination. </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="False" position="Named"> <name>EventDestination_Name</name> <description> <para>The name of the event destination. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain less than 64 characters. </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="False" 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="False" position="Named"> <name>KinesisFirehoseDestination_DeliveryStreamARN</name> <description> <para>The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to. </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="False" position="Named"> <name>KinesisFirehoseDestination_IAMRoleARN</name> <description> <para>The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationSetName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>SNSDestination_TopicARN</name> <description> <para>The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <a href="http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html">Amazon SNS Developer Guide</a>. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ConfigurationSetName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.UpdateConfigurationSetEventDestinationResponse) 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=Update-SESConfigurationSetEventDestination.html&tocid=Update-SESConfigurationSetEventDestination</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Update-SESConfigurationSetTrackingOption</name> <description> <para>Invokes the UpdateConfigurationSetTrackingOptions operation against Amazon Simple Email Service.</para> </description> <verb>Update</verb> <noun>SESConfigurationSetTrackingOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using configuration sets, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer Guide</a>. </para> </description> <syntax> <syntaxItem> <name>Update-SESConfigurationSetTrackingOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TrackingOption</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.TrackingOptions</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set for which you want to update the custom tracking domain. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TrackingOption parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ConfigurationSetName</name> <description> <para>The name of the configuration set for which you want to update the custom tracking domain. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TrackingOption parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>TrackingOption</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.TrackingOptions</parameterValue> <type> <name>Amazon.SimpleEmail.Model.TrackingOptions</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.SimpleEmail.Model.TrackingOptions</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TrackingOption parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.UpdateConfigurationSetTrackingOptionsResponse) 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=Update-SESConfigurationSetTrackingOption.html&tocid=Update-SESConfigurationSetTrackingOption</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Update-SESReceiptRule</name> <description> <para>Invokes the UpdateReceiptRule operation against Amazon Simple Email Service.</para> </description> <verb>Update</verb> <noun>SESReceiptRule</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a receipt rule. For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Update-SESReceiptRule</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Action</name> <description> <para>An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.ReceiptAction[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Enabled</name> <description> <para>If <code>true</code>, the receipt rule is active. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Name</name> <description> <para>The name of the receipt rule. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Recipient</name> <description> <para>The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set that the receipt rule belongs to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_ScanEnabled</name> <description> <para>If <code>true</code>, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_TlsPolicy</name> <description> <para>Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The default is <code>Optional</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.TlsPolicy</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Rule_Action</name> <description> <para>An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.ReceiptAction[]</parameterValue> <type> <name>Amazon.SimpleEmail.Model.ReceiptAction[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Enabled</name> <description> <para>If <code>true</code>, the receipt rule is active. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_Name</name> <description> <para>The name of the receipt rule. The name must: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-). - Start and end with a letter or number. - Contain less than 64 characters. </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="False" position="Named"> <name>Rule_Recipient</name> <description> <para>The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains. </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="False" position="Named"> <name>Rule_ScanEnabled</name> <description> <para>If <code>true</code>, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is <code>false</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Rule_TlsPolicy</name> <description> <para>Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The default is <code>Optional</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.TlsPolicy</parameterValue> <type> <name>Amazon.SimpleEmail.TlsPolicy</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RuleSetName</name> <description> <para>The name of the receipt rule set that the receipt rule belongs to. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.SimpleEmail.Model.UpdateReceiptRuleResponse) 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=Update-SESReceiptRule.html&tocid=Update-SESReceiptRule</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Update-SESTemplate</name> <description> <para>Invokes the UpdateTemplate operation against Amazon Simple Email Service.</para> </description> <verb>Update</verb> <noun>SESTemplate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Update-SESTemplate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Template</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.Template</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Template parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Template parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>Template</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.SimpleEmail.Model.Template</parameterValue> <type> <name>Amazon.SimpleEmail.Model.Template</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.SimpleEmail.Model.Template</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Template parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.UpdateTemplateResponse) 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=Update-SESTemplate.html&tocid=Update-SESTemplate</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Write-SESIdentityPolicy</name> <description> <para>Invokes the PutIdentityPolicy operation against Amazon Simple Email Service.</para> </description> <verb>Write</verb> <noun>SESIdentityPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will return an error. Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. You can execute this operation no more than once per second. </para> </description> <syntax> <syntaxItem> <name>Write-SESIdentityPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Policy</name> <description> <para>The text of the policy in JSON format. The policy cannot exceed 4 KB. For information about the syntax of sending authorization policies, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html">Amazon SES Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Identity</name> <description> <para>The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. To successfully call this API, you must own the identity. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PolicyName</name> <description> <para>The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Policy parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>Identity</name> <description> <para>The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>. To successfully call this API, you must own the identity. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Policy parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>Policy</name> <description> <para>The text of the policy in JSON format. The policy cannot exceed 4 KB. For information about the syntax of sending authorization policies, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html">Amazon SES Developer Guide</a>. </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="False" position="Named"> <name>PolicyName</name> <description> <para>The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Policy parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.SimpleEmail.Model.PutIdentityPolicyResponse) 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=Write-SESIdentityPolicy.html&tocid=Write-SESIdentityPolicy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/ses/latest/APIReference/</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>Get-SHLDAttack</name> <description> <para>Invokes the DescribeAttack operation against AWS Shield.</para> </description> <verb>Get</verb> <noun>SHLDAttack</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the details of a DDoS attack. </para> </description> <syntax> <syntaxItem> <name>Get-SHLDAttack</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AttackId</name> <description> <para>The unique identifier (ID) for the attack that to be described. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AttackId</name> <description> <para>The unique identifier (ID) for the attack that to be described. </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.Shield.Model.AttackDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a AttackDetail object. The service call response (type Amazon.Shield.Model.DescribeAttackResponse) 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-SHLDAttack.html&tocid=Get-SHLDAttack</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>Get-SHLDAttackList</name> <description> <para>Invokes the ListAttacks operation against AWS Shield.</para> </description> <verb>Get</verb> <noun>SHLDAttackList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SHLDAttackList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime_FromInclusive</name> <description> <para>The start time, in the format 2016-12-16T13:50Z. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime_FromInclusive</name> <description> <para>The start time, in the format 2016-12-16T13:50Z. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime_ToExclusive</name> <description> <para>The end time, in the format 2016-12-16T15:50Z. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime_ToExclusive</name> <description> <para>The end time, in the format 2016-12-16T15:50Z. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of <a>AttackSummary</a> objects to be returned. If this is left blank, the first 20 results will be returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The <code>ListAttacksRequest.NextMarker</code> value from a previous call to <code>ListAttacksRequest</code>. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime_FromInclusive</name> <description> <para>The start time, in the format 2016-12-16T13:50Z. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime_ToExclusive</name> <description> <para>The end time, in the format 2016-12-16T15:50Z. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of <a>AttackSummary</a> objects to be returned. If this is left blank, the first 20 results will be returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The <code>ListAttacksRequest.NextMarker</code> value from a previous call to <code>ListAttacksRequest</code>. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included. </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="False" position="Named"> <name>StartTime_FromInclusive</name> <description> <para>The start time, in the format 2016-12-16T13:50Z. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime_ToExclusive</name> <description> <para>The end time, in the format 2016-12-16T15:50Z. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Shield.Model.AttackSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of AttackSummary objects. The service call response (type Amazon.Shield.Model.ListAttacksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SHLDAttackList.html&tocid=Get-SHLDAttackList</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>Get-SHLDProtection</name> <description> <para>Invokes the DescribeProtection operation against AWS Shield.</para> </description> <verb>Get</verb> <noun>SHLDProtection</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the details of a <a>Protection</a> object. </para> </description> <syntax> <syntaxItem> <name>Get-SHLDProtection</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProtectionId</name> <description> <para>The unique identifier (ID) for the <a>Protection</a> object that is described. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProtectionId</name> <description> <para>The unique identifier (ID) for the <a>Protection</a> object that is described. </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.Shield.Model.Protection</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Protection object. The service call response (type Amazon.Shield.Model.DescribeProtectionResponse) 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-SHLDProtection.html&tocid=Get-SHLDProtection</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>Get-SHLDProtectionList</name> <description> <para>Invokes the ListProtections operation against AWS Shield.</para> </description> <verb>Get</verb> <noun>SHLDProtectionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all <a>Protection</a> objects for the account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SHLDProtectionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of <a>Protection</a> objects to be returned. If this is left blank the first 20 results will be returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The <code>ListProtectionsRequest.NextToken</code> value from a previous call to <code>ListProtections</code>. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of <a>Protection</a> objects to be returned. If this is left blank the first 20 results will be returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The <code>ListProtectionsRequest.NextToken</code> value from a previous call to <code>ListProtections</code>. Pass null if this is the first call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Shield.Model.Protection</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Protection objects. The service call response (type Amazon.Shield.Model.ListProtectionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SHLDProtectionList.html&tocid=Get-SHLDProtectionList</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>Get-SHLDSubscription</name> <description> <para>Invokes the DescribeSubscription operation against AWS Shield.</para> </description> <verb>Get</verb> <noun>SHLDSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Provides details about the AWS Shield Advanced subscription for an account. </para> </description> <syntax> <syntaxItem> <name>Get-SHLDSubscription</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.Shield.Model.Subscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Subscription object. The service call response (type Amazon.Shield.Model.DescribeSubscriptionResponse) 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-SHLDSubscription.html&tocid=Get-SHLDSubscription</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>New-SHLDProtection</name> <description> <para>Invokes the CreateProtection operation against AWS Shield.</para> </description> <verb>New</verb> <noun>SHLDProtection</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, or an Amazon Route 53 hosted zone. </para> </description> <syntax> <syntaxItem> <name>New-SHLDProtection</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource to be protected. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Name</name> <description> <para>Friendly name for the <code>Protection</code> you are creating. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>Name</name> <description> <para>Friendly name for the <code>Protection</code> you are creating. </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 (ByValue, ByPropertyName)" position="1"> <name>ResourceArn</name> <description> <para>The ARN (Amazon Resource Name) of the resource to be protected. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Shield.Model.CreateProtectionResponse) 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=New-SHLDProtection.html&tocid=New-SHLDProtection</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>New-SHLDSubscription</name> <description> <para>Invokes the CreateSubscription operation against AWS Shield.</para> </description> <verb>New</verb> <noun>SHLDSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Activates AWS Shield Advanced for an account. </para> </description> <syntax> <syntaxItem> <name>New-SHLDSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.Shield.Model.CreateSubscriptionResponse) 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=New-SHLDSubscription.html&tocid=New-SHLDSubscription</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-SHLDProtection</name> <description> <para>Invokes the DeleteProtection operation against AWS Shield.</para> </description> <verb>Remove</verb> <noun>SHLDProtection</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an AWS Shield Advanced <a>Protection</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-SHLDProtection</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProtectionId</name> <description> <para>The unique identifier (ID) for the <a>Protection</a> object to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProtectionId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProtectionId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>ProtectionId</name> <description> <para>The unique identifier (ID) for the <a>Protection</a> object to be deleted. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ProtectionId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Shield.Model.DeleteProtectionResponse) 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-SHLDProtection.html&tocid=Remove-SHLDProtection</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-SHLDSubscription</name> <description> <para>Invokes the DeleteSubscription operation against AWS Shield.</para> </description> <verb>Remove</verb> <noun>SHLDSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes AWS Shield Advanced from an account. </para> </description> <syntax> <syntaxItem> <name>Remove-SHLDSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.Shield.Model.DeleteSubscriptionResponse) 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-SHLDSubscription.html&tocid=Remove-SHLDSubscription</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>Add-SCTagOptionToResource</name> <description> <para>Invokes the AssociateTagOptionWithResource operation against AWS Service Catalog.</para> </description> <verb>Add</verb> <noun>SCTagOptionToResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associate a TagOption identifier with a resource identifier. </para> </description> <syntax> <syntaxItem> <name>Add-SCTagOptionToResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TagOptionId</name> <description> <para>The TagOption identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceId</name> <description> <para>The resource identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TagOptionId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TagOptionId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ResourceId</name> <description> <para>The resource identifier. </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 (ByValue, )" position="1"> <name>TagOptionId</name> <description> <para>The TagOption identifier. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TagOptionId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.AssociateTagOptionWithResourceResponse) 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=Add-SCTagOptionToResource.html&tocid=Add-SCTagOptionToResource</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Copy-SCProduct</name> <description> <para>Invokes the CopyProduct operation against AWS Service Catalog.</para> </description> <verb>Copy</verb> <noun>SCProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Copies the specified source product to the specified target product or a new product. You can copy the product to the same account or another account. You can copy the product to the same region or another region. This operation is performed asynchronously. To track the progress of the operation, use <a>DescribeCopyProductStatus</a>. </para> </description> <syntax> <syntaxItem> <name>Copy-SCProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyOption</name> <description> <para>The copy options. If the value is <code>CopyTags</code>, the tags from the source product are copied to the target product. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdempotencyToken</name> <description> <para> A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceProductArn</name> <description> <para>The Amazon Resource Name (ARN) of the source product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceProvisioningArtifactIdentifier</name> <description> <para>The IDs of the product versions to copy. By default, all provisioning artifacts are copied. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetProductId</name> <description> <para>The ID of the target product. By default, a new product is created. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetProductName</name> <description> <para>A name for the target product. The default is the name of the source product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>CopyOption</name> <description> <para>The copy options. If the value is <code>CopyTags</code>, the tags from the source product are copied to the target product. </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="False" 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="False" position="Named"> <name>IdempotencyToken</name> <description> <para> A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </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="False" position="Named"> <name>SourceProductArn</name> <description> <para>The Amazon Resource Name (ARN) of the source product. </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="False" position="Named"> <name>SourceProvisioningArtifactIdentifier</name> <description> <para>The IDs of the product versions to copy. By default, all provisioning artifacts are copied. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable[]</parameterValue> <type> <name>System.Collections.Hashtable[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetProductId</name> <description> <para>The ID of the target product. By default, a new product is created. </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="False" position="Named"> <name>TargetProductName</name> <description> <para>A name for the target product. The default is the name of the source product. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.ServiceCatalog.Model.CopyProductResponse) 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=Copy-SCProduct.html&tocid=Copy-SCProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Deny-SCPortfolioShare</name> <description> <para>Invokes the RejectPortfolioShare operation against AWS Service Catalog.</para> </description> <verb>Deny</verb> <noun>SCPortfolioShare</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Rejects an offer to share a portfolio. </para> </description> <syntax> <syntaxItem> <name>Deny-SCPortfolioShare</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PortfolioId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PortfolioId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PortfolioId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.RejectPortfolioShareResponse) 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=Deny-SCPortfolioShare.html&tocid=Deny-SCPortfolioShare</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Find-SCProduct</name> <description> <para>Invokes the SearchProducts operation against AWS Service Catalog.</para> </description> <verb>Find</verb> <noun>SCProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a paginated list all of the <code>Products</code> objects to which the caller has access. The output of this operation can be used as input for other operations, such as <a>DescribeProductView</a>. </para> </description> <syntax> <syntaxItem> <name>Find-SCProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortBy</name> <description> <para>The sort field specifier. If no value is specified, results are not sorted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProductViewSortBy</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortOrder</name> <description> <para>The sort order specifier. If no value is specified, results are not sorted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.SortOrder</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>Filter</name> <description> <para>The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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="False" position="Named"> <name>SortBy</name> <description> <para>The sort field specifier. If no value is specified, results are not sorted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProductViewSortBy</parameterValue> <type> <name>Amazon.ServiceCatalog.ProductViewSortBy</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortOrder</name> <description> <para>The sort order specifier. If no value is specified, results are not sorted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.SortOrder</parameterValue> <type> <name>Amazon.ServiceCatalog.SortOrder</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.ServiceCatalog.Model.SearchProductsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.SearchProductsResponse 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=Find-SCProduct.html&tocid=Find-SCProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCAcceptedPortfolioSharesList</name> <description> <para>Invokes the ListAcceptedPortfolioShares operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCAcceptedPortfolioSharesList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists details of all portfolios for which sharing was accepted by this account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCAcceptedPortfolioSharesList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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.ServiceCatalog.Model.PortfolioDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PortfolioDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ListAcceptedPortfolioSharesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCAcceptedPortfolioSharesList.html&tocid=Get-SCAcceptedPortfolioSharesList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCConstrainsForPortfolioList</name> <description> <para>Invokes the ListConstraintsForPortfolio operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCConstrainsForPortfolioList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves detailed constraint information for the specified portfolio and product.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCConstrainsForPortfolioList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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 (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </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.ServiceCatalog.Model.ConstraintDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ConstraintDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ListConstraintsForPortfolioResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCConstrainsForPortfolioList.html&tocid=Get-SCConstrainsForPortfolioList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCConstraint</name> <description> <para>Invokes the DescribeConstraint operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCConstraint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves detailed information for a specified constraint. </para> </description> <syntax> <syntaxItem> <name>Get-SCConstraint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the constraint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the constraint. </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.ServiceCatalog.Model.DescribeConstraintResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribeConstraintResponse 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-SCConstraint.html&tocid=Get-SCConstraint</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCCopyProductStatus</name> <description> <para>Invokes the DescribeCopyProductStatus operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCCopyProductStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the status of the specified copy product operation. </para> </description> <syntax> <syntaxItem> <name>Get-SCCopyProductStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyProductToken</name> <description> <para>The token returned from the call to <code>CopyProduct</code> that initiated the operation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>CopyProductToken</name> <description> <para>The token returned from the call to <code>CopyProduct</code> that initiated the operation. </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.ServiceCatalog.Model.DescribeCopyProductStatusResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribeCopyProductStatusResponse 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-SCCopyProductStatus.html&tocid=Get-SCCopyProductStatus</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCLaunchPath</name> <description> <para>Invokes the ListLaunchPaths operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCLaunchPath</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCLaunchPath</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. Identifies the product for which to retrieve <code>LaunchPathSummaries</code> information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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 (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. Identifies the product for which to retrieve <code>LaunchPathSummaries</code> information. </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.ServiceCatalog.Model.LaunchPathSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of LaunchPathSummary objects. The service call response (type Amazon.ServiceCatalog.Model.ListLaunchPathsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCLaunchPath.html&tocid=Get-SCLaunchPath</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCPortfolio</name> <description> <para>Invokes the DescribePortfolio operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves detailed information and any tags associated with the specified portfolio. </para> </description> <syntax> <syntaxItem> <name>Get-SCPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the portfolio for which to retrieve information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the portfolio for which to retrieve information. </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.ServiceCatalog.Model.DescribePortfolioResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribePortfolioResponse 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-SCPortfolio.html&tocid=Get-SCPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCPortfolioAccessList</name> <description> <para>Invokes the ListPortfolioAccess operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCPortfolioAccessList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the account IDs that have been authorized sharing of the specified portfolio. </para> </description> <syntax> <syntaxItem> <name>Get-SCPortfolioAccessList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.ServiceCatalog.Model.ListPortfolioAccessResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCPortfolioAccessList.html&tocid=Get-SCPortfolioAccessList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCPortfolioList</name> <description> <para>Invokes the ListPortfolios operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCPortfolioList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all portfolios in the catalog.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCPortfolioList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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.ServiceCatalog.Model.PortfolioDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PortfolioDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ListPortfoliosResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCPortfolioList.html&tocid=Get-SCPortfolioList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCPrincipalsForPortfolio</name> <description> <para>Invokes the ListPrincipalsForPortfolio operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCPrincipalsForPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all principal ARNs associated with the specified portfolio.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCPrincipalsForPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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 (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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.ServiceCatalog.Model.Principal</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Principal objects. The service call response (type Amazon.ServiceCatalog.Model.ListPrincipalsForPortfolioResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCPrincipalsForPortfolio.html&tocid=Get-SCPrincipalsForPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProduct</name> <description> <para>Invokes the DescribeProduct operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about a specified product. This operation is functionally identical to <a>DescribeProductView</a> except that it takes as input <code>ProductId</code> instead of <code>ProductViewId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-SCProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The <code>ProductId</code> of the product to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The <code>ProductId</code> of the product to describe. </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.ServiceCatalog.Model.DescribeProductResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribeProductResponse 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-SCProduct.html&tocid=Get-SCProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProductAsAdmin</name> <description> <para>Invokes the DescribeProductAsAdmin operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProductAsAdmin</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about a specified product, run with administrator access. </para> </description> <syntax> <syntaxItem> <name>Get-SCProductAsAdmin</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the product for which to retrieve information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the product for which to retrieve information. </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.ServiceCatalog.Model.DescribeProductAsAdminResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribeProductAsAdminResponse 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-SCProductAsAdmin.html&tocid=Get-SCProductAsAdmin</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProductPortfoliosList</name> <description> <para>Invokes the ListPortfoliosForProduct operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProductPortfoliosList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all portfolios that the specified product is associated with.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCProductPortfoliosList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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 (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </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.ServiceCatalog.Model.PortfolioDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PortfolioDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ListPortfoliosForProductResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCProductPortfoliosList.html&tocid=Get-SCProductPortfoliosList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProductView</name> <description> <para>Invokes the DescribeProductView operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProductView</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about a specified product. This operation is functionally identical to <a>DescribeProduct</a> except that it takes as input <code>ProductViewId</code> instead of <code>ProductId</code>. </para> </description> <syntax> <syntaxItem> <name>Get-SCProductView</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The <code>ProductViewId</code> of the product to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The <code>ProductViewId</code> of the product to describe. </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.ServiceCatalog.Model.DescribeProductViewResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribeProductViewResponse 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-SCProductView.html&tocid=Get-SCProductView</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProvisionedProduct</name> <description> <para>Invokes the ScanProvisionedProducts operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProvisionedProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCProvisionedProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccessLevelFilter_Key</name> <description> <para>Specifies the access level. <code>Account</code> allows results at the account level. <code>Role</code> allows results based on the federated role of the specified user. <code>User</code> allows results limited to the specified user. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.AccessLevelFilterKey</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccessLevelFilter_Value</name> <description> <para>Specifies the user to which the access level applies. A value of <code>Self</code> is currently supported. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>AccessLevelFilter_Key</name> <description> <para>Specifies the access level. <code>Account</code> allows results at the account level. <code>Role</code> allows results based on the federated role of the specified user. <code>User</code> allows results limited to the specified user. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.AccessLevelFilterKey</parameterValue> <type> <name>Amazon.ServiceCatalog.AccessLevelFilterKey</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccessLevelFilter_Value</name> <description> <para>Specifies the user to which the access level applies. A value of <code>Self</code> is currently supported. </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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.ServiceCatalog.Model.ProvisionedProductDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ProvisionedProductDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ScanProvisionedProductsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCProvisionedProduct.html&tocid=Get-SCProvisionedProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProvisionedProductDetail</name> <description> <para>Invokes the DescribeProvisionedProduct operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProvisionedProductDetail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieve detailed information about the provisioned product. </para> </description> <syntax> <syntaxItem> <name>Get-SCProvisionedProductDetail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The provisioned product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The provisioned product identifier. </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.ServiceCatalog.Model.ProvisionedProductDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ProvisionedProductDetail object. The service call response (type Amazon.ServiceCatalog.Model.DescribeProvisionedProductResponse) 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-SCProvisionedProductDetail.html&tocid=Get-SCProvisionedProductDetail</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProvisioningArtifact</name> <description> <para>Invokes the DescribeProvisioningArtifact operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProvisioningArtifact</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves detailed information about the specified provisioning artifact. </para> </description> <syntax> <syntaxItem> <name>Get-SCProvisioningArtifact</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProvisioningArtifactId</name> <description> <para>The identifier of the provisioning artifact. This is sometimes referred to as the product version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReturnCloudFormationTemplate</name> <description> <para>Enable a verbose level of details for the provisioning artifact. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </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 (ByValue, )" position="1"> <name>ProvisioningArtifactId</name> <description> <para>The identifier of the provisioning artifact. This is sometimes referred to as the product version. </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="False" position="Named"> <name>ReturnCloudFormationTemplate</name> <description> <para>Enable a verbose level of details for the provisioning artifact. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.ServiceCatalog.Model.DescribeProvisioningArtifactResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribeProvisioningArtifactResponse 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-SCProvisioningArtifact.html&tocid=Get-SCProvisioningArtifact</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProvisioningArtifactList</name> <description> <para>Invokes the ListProvisioningArtifacts operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProvisioningArtifactList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all provisioning artifacts associated with the specified product. </para> </description> <syntax> <syntaxItem> <name>Get-SCProvisioningArtifactList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </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.ServiceCatalog.Model.ProvisioningArtifactDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ProvisioningArtifactDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ListProvisioningArtifactsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCProvisioningArtifactList.html&tocid=Get-SCProvisioningArtifactList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCProvisioningParameter</name> <description> <para>Invokes the DescribeProvisioningParameters operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCProvisioningParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of <code>ProvisioningArtifactParameters</code> parameters available to call the <a>ProvisionProduct</a> operation for the specified product. If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to the <code>ProvisionProduct</code> operation, do not include conflicted TagOption keys as tags. Calls to <code>ProvisionProduct</code> with empty TagOption values cause the error "Parameter validation failed: Missing required parameter in Tags[<i>N</i>]:<i>Value</i> ". Calls to <code>ProvisionProduct</code> with conflicted TagOption keys automatically tag the provisioned product with the conflicted keys with the value "<code>sc-tagoption-conflict-portfolioId-productId</code>". </para> </description> <syntax> <syntaxItem> <name>Get-SCProvisioningParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PathId</name> <description> <para>The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactId</name> <description> <para>The provisioning artifact identifier for this product. This is sometimes referred to as the product version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>PathId</name> <description> <para>The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product. </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 (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </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="False" position="Named"> <name>ProvisioningArtifactId</name> <description> <para>The provisioning artifact identifier for this product. This is sometimes referred to as the product version. </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.ServiceCatalog.Model.DescribeProvisioningParametersResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribeProvisioningParametersResponse 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-SCProvisioningParameter.html&tocid=Get-SCProvisioningParameter</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCRecord</name> <description> <para>Invokes the DescribeRecord operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCRecord</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (<a>ProvisionProduct</a>, <a>TerminateProvisionedProduct</a>, or <a>UpdateProvisionedProduct</a>). </para> </description> <syntax> <syntaxItem> <name>Get-SCRecord</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the <code>RecordDetail.RecordId</code> obtained from the request operation's response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the <code>RecordDetail.RecordId</code> obtained from the request operation's response. </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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.ServiceCatalog.Model.DescribeRecordResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.DescribeRecordResponse 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-SCRecord.html&tocid=Get-SCRecord</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCRecordHistory</name> <description> <para>Invokes the ListRecordHistory operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCRecordHistory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCRecordHistory</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccessLevelFilter_Key</name> <description> <para>Specifies the access level. <code>Account</code> allows results at the account level. <code>Role</code> allows results based on the federated role of the specified user. <code>User</code> allows results limited to the specified user. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.AccessLevelFilterKey</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SearchFilter_Key</name> <description> <para>The filter key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccessLevelFilter_Value</name> <description> <para>Specifies the user to which the access level applies. A value of <code>Self</code> is currently supported. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SearchFilter_Value</name> <description> <para>The filter value for <code>Key</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>AccessLevelFilter_Key</name> <description> <para>Specifies the access level. <code>Account</code> allows results at the account level. <code>Role</code> allows results based on the federated role of the specified user. <code>User</code> allows results limited to the specified user. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.AccessLevelFilterKey</parameterValue> <type> <name>Amazon.ServiceCatalog.AccessLevelFilterKey</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccessLevelFilter_Value</name> <description> <para>Specifies the user to which the access level applies. A value of <code>Self</code> is currently supported. </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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="False" position="Named"> <name>SearchFilter_Key</name> <description> <para>The filter key. </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="False" position="Named"> <name>SearchFilter_Value</name> <description> <para>The filter value for <code>Key</code>. </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.ServiceCatalog.Model.RecordDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RecordDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ListRecordHistoryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCRecordHistory.html&tocid=Get-SCRecordHistory</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCResourcesForTagOption</name> <description> <para>Invokes the ListResourcesForTagOption operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCResourcesForTagOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists resources associated with a TagOption.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCResourcesForTagOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TagOptionId</name> <description> <para>Identifier of the TagOption. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>Resource type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>ResourceType</name> <description> <para>Resource type. </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 (ByValue, )" position="1"> <name>TagOptionId</name> <description> <para>Identifier of the TagOption. </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.ServiceCatalog.Model.ResourceDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ResourceDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ListResourcesForTagOptionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: PageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCResourcesForTagOption.html&tocid=Get-SCResourcesForTagOption</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCTagOption</name> <description> <para>Invokes the DescribeTagOption operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCTagOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes a TagOption. </para> </description> <syntax> <syntaxItem> <name>Get-SCTagOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the TagOption. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the TagOption. </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.ServiceCatalog.Model.TagOptionDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TagOptionDetail object. The service call response (type Amazon.ServiceCatalog.Model.DescribeTagOptionResponse) 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-SCTagOption.html&tocid=Get-SCTagOption</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SCTagOptionList</name> <description> <para>Invokes the ListTagOptions operation against AWS Service Catalog.</para> </description> <verb>Get</verb> <noun>SCTagOptionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists detailed TagOptions information.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SCTagOptionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filters_Active</name> <description> <para>The ListTagOptionsFilters active state. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filters_Key</name> <description> <para>The ListTagOptionsFilters key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filters_Value</name> <description> <para>The ListTagOptionsFilters value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filters_Active</name> <description> <para>The ListTagOptionsFilters active state. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filters_Key</name> <description> <para>The ListTagOptionsFilters key. </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="False" position="Named"> <name>Filters_Value</name> <description> <para>The ListTagOptionsFilters value. </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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.ServiceCatalog.Model.TagOptionDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TagOptionDetail objects. The service call response (type Amazon.ServiceCatalog.Model.ListTagOptionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: PageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SCTagOptionList.html&tocid=Get-SCTagOptionList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>New-SCConstraint</name> <description> <para>Invokes the CreateConstraint operation against AWS Service Catalog.</para> </description> <verb>New</verb> <noun>SCConstraint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new constraint. For more information, see <a href="http://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html">Using Constraints</a>. </para> </description> <syntax> <syntaxItem> <name>New-SCConstraint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The text description of the constraint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdempotencyToken</name> <description> <para>A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameter</name> <description> <para>The constraint parameters. Expected values vary depending on which <b>Type</b> is specified. For more information, see the Examples section. For Type <code>LAUNCH</code>, the <code>RoleArn</code> property is required. For Type <code>NOTIFICATION</code>, the <code>NotificationArns</code> property is required. For Type <code>TEMPLATE</code>, the <code>Rules</code> property is required. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Type</name> <description> <para>The type of the constraint. Case-sensitive valid values are: <code>LAUNCH</code>, <code>NOTIFICATION</code>, or <code>TEMPLATE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>Description</name> <description> <para>The text description of the constraint. </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="False" 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="False" position="Named"> <name>IdempotencyToken</name> <description> <para>A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </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="False" position="Named"> <name>Parameter</name> <description> <para>The constraint parameters. Expected values vary depending on which <b>Type</b> is specified. For more information, see the Examples section. For Type <code>LAUNCH</code>, the <code>RoleArn</code> property is required. For Type <code>NOTIFICATION</code>, the <code>NotificationArns</code> property is required. For Type <code>TEMPLATE</code>, the <code>Rules</code> property is required. </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="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </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="False" position="Named"> <name>Type</name> <description> <para>The type of the constraint. Case-sensitive valid values are: <code>LAUNCH</code>, <code>NOTIFICATION</code>, or <code>TEMPLATE</code>. </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.ServiceCatalog.Model.CreateConstraintResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.CreateConstraintResponse 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=New-SCConstraint.html&tocid=New-SCConstraint</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>New-SCPortfolio</name> <description> <para>Invokes the CreatePortfolio operation against AWS Service Catalog.</para> </description> <verb>New</verb> <noun>SCPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new portfolio. </para> </description> <syntax> <syntaxItem> <name>New-SCPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The text description of the portfolio. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DisplayName</name> <description> <para>The name to use for display purposes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdempotencyToken</name> <description> <para>A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProviderName</name> <description> <para>The name of the portfolio provider. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Tags to associate with the new portfolio. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>Description</name> <description> <para>The text description of the portfolio. </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="False" position="Named"> <name>DisplayName</name> <description> <para>The name to use for display purposes. </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="False" 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="False" position="Named"> <name>IdempotencyToken</name> <description> <para>A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </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="False" position="Named"> <name>ProviderName</name> <description> <para>The name of the portfolio provider. </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="False" position="Named"> <name>Tag</name> <description> <para>Tags to associate with the new portfolio. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> <type> <name>Amazon.ServiceCatalog.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.ServiceCatalog.Model.CreatePortfolioResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.CreatePortfolioResponse 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=New-SCPortfolio.html&tocid=New-SCPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>New-SCPortfolioShare</name> <description> <para>Invokes the CreatePortfolioShare operation against AWS Service Catalog.</para> </description> <verb>New</verb> <noun>SCPortfolioShare</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new portfolio share. </para> </description> <syntax> <syntaxItem> <name>New-SCPortfolioShare</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The account ID with which to share the portfolio. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The account ID with which to share the portfolio. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AccountId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.CreatePortfolioShareResponse) 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=New-SCPortfolioShare.html&tocid=New-SCPortfolioShare</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>New-SCProduct</name> <description> <para>Invokes the CreateProduct operation against AWS Service Catalog.</para> </description> <verb>New</verb> <noun>SCProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new product. </para> </description> <syntax> <syntaxItem> <name>New-SCProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The text description of the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactParameters_Description</name> <description> <para>The text description of the provisioning artifact properties. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Distributor</name> <description> <para>The distributor of the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdempotencyToken</name> <description> <para>A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactParameters_Info</name> <description> <para>Additional information about the provisioning artifact properties. When using this element in a request, you must specify <code>LoadTemplateFromURL</code>. For more information, see <a>CreateProvisioningArtifact</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The name of the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactParameters_Name</name> <description> <para>The name assigned to the provisioning artifact properties. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductType</name> <description> <para>The type of the product to create. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProductType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SupportDescription</name> <description> <para>Support information about the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SupportEmail</name> <description> <para>Contact email for product support. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SupportUrl</name> <description> <para>Contact URL for product support. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Tags to associate with the new product. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactParameters_Type</name> <description> <para>The type of the provisioning artifact properties. The following provisioning artifact property types are used by AWS Marketplace products: <code>MARKETPLACE_AMI</code> - AMI products. <code>MARKETPLACE_CAR</code> - CAR (Cluster and AWS Resources) products. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProvisioningArtifactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Owner</name> <description> <para>The owner of the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>Description</name> <description> <para>The text description of the product. </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="False" position="Named"> <name>Distributor</name> <description> <para>The distributor of the product. </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="False" 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="False" position="Named"> <name>IdempotencyToken</name> <description> <para>A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </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="False" position="Named"> <name>Name</name> <description> <para>The name of the product. </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="False" position="Named"> <name>Owner</name> <description> <para>The owner of the product. </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="False" position="Named"> <name>ProductType</name> <description> <para>The type of the product to create. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProductType</parameterValue> <type> <name>Amazon.ServiceCatalog.ProductType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactParameters_Description</name> <description> <para>The text description of the provisioning artifact properties. </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="False" position="Named"> <name>ProvisioningArtifactParameters_Info</name> <description> <para>Additional information about the provisioning artifact properties. When using this element in a request, you must specify <code>LoadTemplateFromURL</code>. For more information, see <a>CreateProvisioningArtifact</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactParameters_Name</name> <description> <para>The name assigned to the provisioning artifact properties. </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="False" position="Named"> <name>ProvisioningArtifactParameters_Type</name> <description> <para>The type of the provisioning artifact properties. The following provisioning artifact property types are used by AWS Marketplace products: <code>MARKETPLACE_AMI</code> - AMI products. <code>MARKETPLACE_CAR</code> - CAR (Cluster and AWS Resources) products. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProvisioningArtifactType</parameterValue> <type> <name>Amazon.ServiceCatalog.ProvisioningArtifactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SupportDescription</name> <description> <para>Support information about the product. </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="False" position="Named"> <name>SupportEmail</name> <description> <para>Contact email for product support. </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="False" position="Named"> <name>SupportUrl</name> <description> <para>Contact URL for product support. </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="False" position="Named"> <name>Tag</name> <description> <para>Tags to associate with the new product. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> <type> <name>Amazon.ServiceCatalog.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.ServiceCatalog.Model.CreateProductResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.CreateProductResponse 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=New-SCProduct.html&tocid=New-SCProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>New-SCProvisionedProduct</name> <description> <para>Invokes the ProvisionProduct operation against AWS Service Catalog.</para> </description> <verb>New</verb> <noun>SCProvisionedProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests a <i>provision</i> of a specified product. A <i>provisioned product</i> is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it. You can check the status of this request using the <a>DescribeRecord</a> operation. The error "Parameter validation failed: Missing required parameter in Tags[<i>N</i>]:<i>Value</i>" indicates that your request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may have included values returned from a <code>DescribeProvisioningParameters</code> call that resulted in a TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see <a>DescribeProvisioningParameters</a>. </para> </description> <syntax> <syntaxItem> <name>New-SCProvisionedProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProvisionedProductName</name> <description> <para>A user-friendly name to identify the ProvisionedProduct object. This value must be unique for the AWS account and cannot be updated after the product is provisioned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NotificationArn</name> <description> <para>Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PathId</name> <description> <para>The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactId</name> <description> <para>The provisioning artifact identifier for this product. This is sometimes referred to as the product version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningParameter</name> <description> <para>Parameters specified by the administrator that are required for provisioning the product. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.ProvisioningParameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisionToken</name> <description> <para>An idempotency token that uniquely identifies the provisioning request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tags to use as provisioning options. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>NotificationArn</name> <description> <para>Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. </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="False" position="Named"> <name>PathId</name> <description> <para>The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product. </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="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </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 (ByValue, )" position="1"> <name>ProvisionedProductName</name> <description> <para>A user-friendly name to identify the ProvisionedProduct object. This value must be unique for the AWS account and cannot be updated after the product is provisioned. </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="False" position="Named"> <name>ProvisioningArtifactId</name> <description> <para>The provisioning artifact identifier for this product. This is sometimes referred to as the product version. </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="False" position="Named"> <name>ProvisioningParameter</name> <description> <para>Parameters specified by the administrator that are required for provisioning the product. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.ProvisioningParameter[]</parameterValue> <type> <name>Amazon.ServiceCatalog.Model.ProvisioningParameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisionToken</name> <description> <para>An idempotency token that uniquely identifies the provisioning request. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tags to use as provisioning options. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> <type> <name>Amazon.ServiceCatalog.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.ServiceCatalog.Model.RecordDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RecordDetail object. The service call response (type Amazon.ServiceCatalog.Model.ProvisionProductResponse) 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=New-SCProvisionedProduct.html&tocid=New-SCProvisionedProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>New-SCProvisioningArtifact</name> <description> <para>Invokes the CreateProvisioningArtifact operation against AWS Service Catalog.</para> </description> <verb>New</verb> <noun>SCProvisioningArtifact</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you. </para> </description> <syntax> <syntaxItem> <name>New-SCProvisioningArtifact</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameters_Description</name> <description> <para>The text description of the provisioning artifact properties. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdempotencyToken</name> <description> <para>A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameters_Info</name> <description> <para>Additional information about the provisioning artifact properties. When using this element in a request, you must specify <code>LoadTemplateFromURL</code>. For more information, see <a>CreateProvisioningArtifact</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameters_Name</name> <description> <para>The name assigned to the provisioning artifact properties. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameters_Type</name> <description> <para>The type of the provisioning artifact properties. The following provisioning artifact property types are used by AWS Marketplace products: <code>MARKETPLACE_AMI</code> - AMI products. <code>MARKETPLACE_CAR</code> - CAR (Cluster and AWS Resources) products. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProvisioningArtifactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>IdempotencyToken</name> <description> <para>A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request. </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="False" position="Named"> <name>Parameters_Description</name> <description> <para>The text description of the provisioning artifact properties. </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="False" position="Named"> <name>Parameters_Info</name> <description> <para>Additional information about the provisioning artifact properties. When using this element in a request, you must specify <code>LoadTemplateFromURL</code>. For more information, see <a>CreateProvisioningArtifact</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameters_Name</name> <description> <para>The name assigned to the provisioning artifact properties. </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="False" position="Named"> <name>Parameters_Type</name> <description> <para>The type of the provisioning artifact properties. The following provisioning artifact property types are used by AWS Marketplace products: <code>MARKETPLACE_AMI</code> - AMI products. <code>MARKETPLACE_CAR</code> - CAR (Cluster and AWS Resources) products. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProvisioningArtifactType</parameterValue> <type> <name>Amazon.ServiceCatalog.ProvisioningArtifactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </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.ServiceCatalog.Model.CreateProvisioningArtifactResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.CreateProvisioningArtifactResponse 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=New-SCProvisioningArtifact.html&tocid=New-SCProvisioningArtifact</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>New-SCTagOption</name> <description> <para>Invokes the CreateTagOption operation against AWS Service Catalog.</para> </description> <verb>New</verb> <noun>SCTagOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Create a new TagOption. </para> </description> <syntax> <syntaxItem> <name>New-SCTagOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Value</name> <description> <para>The TagOption value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Key</name> <description> <para>The TagOption key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Key</name> <description> <para>The TagOption key. </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 (ByValue, )" position="1"> <name>Value</name> <description> <para>The TagOption 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.ServiceCatalog.Model.TagOptionDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TagOptionDetail object. The service call response (type Amazon.ServiceCatalog.Model.CreateTagOptionResponse) 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=New-SCTagOption.html&tocid=New-SCTagOption</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Receive-SCPortfolioShare</name> <description> <para>Invokes the AcceptPortfolioShare operation against AWS Service Catalog.</para> </description> <verb>Receive</verb> <noun>SCPortfolioShare</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Accepts an offer to share a portfolio. </para> </description> <syntax> <syntaxItem> <name>Receive-SCPortfolioShare</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PortfolioId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PortfolioId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PortfolioId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.AcceptPortfolioShareResponse) 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=Receive-SCPortfolioShare.html&tocid=Receive-SCPortfolioShare</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Register-SCPrincipalWithPortfolio</name> <description> <para>Invokes the AssociatePrincipalWithPortfolio operation against AWS Service Catalog.</para> </description> <verb>Register</verb> <noun>SCPrincipalWithPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates the specified principal ARN with the specified portfolio. </para> </description> <syntax> <syntaxItem> <name>Register-SCPrincipalWithPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PrincipalARN</name> <description> <para>The ARN representing the principal (IAM user, role, or group). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrincipalType</name> <description> <para>The principal type. Must be <code>IAM</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.PrincipalType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PrincipalARN parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PrincipalARN parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 (ByValue, )" position="1"> <name>PrincipalARN</name> <description> <para>The ARN representing the principal (IAM user, role, or group). </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="False" position="Named"> <name>PrincipalType</name> <description> <para>The principal type. Must be <code>IAM</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.PrincipalType</parameterValue> <type> <name>Amazon.ServiceCatalog.PrincipalType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PrincipalARN parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.AssociatePrincipalWithPortfolioResponse) 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=Register-SCPrincipalWithPortfolio.html&tocid=Register-SCPrincipalWithPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Register-SCProductWithPortfolio</name> <description> <para>Invokes the AssociateProductWithPortfolio operation against AWS Service Catalog.</para> </description> <verb>Register</verb> <noun>SCProductWithPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates a product with a portfolio. </para> </description> <syntax> <syntaxItem> <name>Register-SCProductWithPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourcePortfolioId</name> <description> <para>The identifier of the source portfolio to use with this association. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProductId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProductId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </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="False" position="Named"> <name>SourcePortfolioId</name> <description> <para>The identifier of the source portfolio to use with this association. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ProductId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.AssociateProductWithPortfolioResponse) 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=Register-SCProductWithPortfolio.html&tocid=Register-SCProductWithPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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-SCConstraint</name> <description> <para>Invokes the DeleteConstraint operation against AWS Service Catalog.</para> </description> <verb>Remove</verb> <noun>SCConstraint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified constraint. </para> </description> <syntax> <syntaxItem> <name>Remove-SCConstraint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the constraint to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the constraint to delete. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Id parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.DeleteConstraintResponse) 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-SCConstraint.html&tocid=Remove-SCConstraint</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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-SCPortfolio</name> <description> <para>Invokes the DeletePortfolio operation against AWS Service Catalog.</para> </description> <verb>Remove</verb> <noun>SCPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it. </para> </description> <syntax> <syntaxItem> <name>Remove-SCPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the portfolio for the delete request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the portfolio for the delete request. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Id parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.DeletePortfolioResponse) 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-SCPortfolio.html&tocid=Remove-SCPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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-SCPortfolioShare</name> <description> <para>Invokes the DeletePortfolioShare operation against AWS Service Catalog.</para> </description> <verb>Remove</verb> <noun>SCPortfolioShare</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified portfolio share. </para> </description> <syntax> <syntaxItem> <name>Remove-SCPortfolioShare</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The account ID associated with the share to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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 (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The account ID associated with the share to delete. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AccountId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.DeletePortfolioShareResponse) 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-SCPortfolioShare.html&tocid=Remove-SCPortfolioShare</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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-SCProduct</name> <description> <para>Invokes the DeleteProduct operation against AWS Service Catalog.</para> </description> <verb>Remove</verb> <noun>SCProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio. </para> </description> <syntax> <syntaxItem> <name>Remove-SCProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the product for the delete request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the product for the delete request. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Id parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.DeleteProductResponse) 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-SCProduct.html&tocid=Remove-SCProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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-SCProvisionedProduct</name> <description> <para>Invokes the TerminateProvisionedProduct operation against AWS Service Catalog.</para> </description> <verb>Remove</verb> <noun>SCProvisionedProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests termination of an existing ProvisionedProduct object. If there are <code>Tags</code> associated with the object, they are terminated when the ProvisionedProduct object is terminated. This operation does not delete any records associated with the ProvisionedProduct object. You can check the status of this request using the <a>DescribeRecord</a> operation. </para> </description> <syntax> <syntaxItem> <name>Remove-SCProvisionedProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProvisionedProductId</name> <description> <para>The identifier of the ProvisionedProduct object to terminate. Specify either <code>ProvisionedProductName</code> or <code>ProvisionedProductId</code>, but not both. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IgnoreError</name> <description> <para>If set to true, AWS Service Catalog stops managing the specified ProvisionedProduct object even if it cannot delete the underlying resources. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisionedProductName</name> <description> <para>The name of the ProvisionedProduct object to terminate. Specify either <code>ProvisionedProductName</code> or <code>ProvisionedProductId</code>, but not both. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TerminateToken</name> <description> <para>An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the ProvisionedProduct object is terminated, further requests to terminate the same ProvisionedProduct object always return <b>ResourceNotFound</b> regardless of the value of <code>TerminateToken</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>IgnoreError</name> <description> <para>If set to true, AWS Service Catalog stops managing the specified ProvisionedProduct object even if it cannot delete the underlying resources. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProvisionedProductId</name> <description> <para>The identifier of the ProvisionedProduct object to terminate. Specify either <code>ProvisionedProductName</code> or <code>ProvisionedProductId</code>, but not both. </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="False" position="Named"> <name>ProvisionedProductName</name> <description> <para>The name of the ProvisionedProduct object to terminate. Specify either <code>ProvisionedProductName</code> or <code>ProvisionedProductId</code>, but not both. </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="False" position="Named"> <name>TerminateToken</name> <description> <para>An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the ProvisionedProduct object is terminated, further requests to terminate the same ProvisionedProduct object always return <b>ResourceNotFound</b> regardless of the value of <code>TerminateToken</code>. </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.ServiceCatalog.Model.RecordDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RecordDetail object. The service call response (type Amazon.ServiceCatalog.Model.TerminateProvisionedProductResponse) 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=Remove-SCProvisionedProduct.html&tocid=Remove-SCProvisionedProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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-SCProvisioningArtifact</name> <description> <para>Invokes the DeleteProvisioningArtifact operation against AWS Service Catalog.</para> </description> <verb>Remove</verb> <noun>SCProvisioningArtifact</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact). </para> </description> <syntax> <syntaxItem> <name>Remove-SCProvisioningArtifact</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProvisioningArtifactId</name> <description> <para>The identifier of the provisioning artifact for the delete request. This is sometimes referred to as the product version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProvisioningArtifactId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProvisioningArtifactId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </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 (ByValue, )" position="1"> <name>ProvisioningArtifactId</name> <description> <para>The identifier of the provisioning artifact for the delete request. This is sometimes referred to as the product version. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ProvisioningArtifactId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.DeleteProvisioningArtifactResponse) 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-SCProvisioningArtifact.html&tocid=Remove-SCProvisioningArtifact</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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-SCTagOptionFromResource</name> <description> <para>Invokes the DisassociateTagOptionFromResource operation against AWS Service Catalog.</para> </description> <verb>Remove</verb> <noun>SCTagOptionFromResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates a TagOption from a resource. </para> </description> <syntax> <syntaxItem> <name>Remove-SCTagOptionFromResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TagOptionId</name> <description> <para>Identifier of the TagOption to disassociate from the resource. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceId</name> <description> <para>Identifier of the resource from which to disassociate the TagOption. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TagOptionId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the TagOptionId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ResourceId</name> <description> <para>Identifier of the resource from which to disassociate the TagOption. </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 (ByValue, )" position="1"> <name>TagOptionId</name> <description> <para>Identifier of the TagOption to disassociate from the resource. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the TagOptionId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.DisassociateTagOptionFromResourceResponse) 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-SCTagOptionFromResource.html&tocid=Remove-SCTagOptionFromResource</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Search-SCProductsAsAdmin</name> <description> <para>Invokes the SearchProductsAsAdmin operation against AWS Service Catalog.</para> </description> <verb>Search</verb> <noun>SCProductsAsAdmin</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Search-SCProductsAsAdmin</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductSource</name> <description> <para>Access level of the source of the product. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProductSource</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortBy</name> <description> <para>The sort field specifier. If no value is specified, results are not sorted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProductViewSortBy</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortOrder</name> <description> <para>The sort order specifier. If no value is specified, results are not sorted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.SortOrder</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>Filter</name> <description> <para>The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PageSize</name> <description> <para>The maximum number of items to return in the results. If more results exist than fit in the specified <code>PageSize</code>, the value of <code>NextPageToken</code> in the response is non-null. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageToken</name> <description> <para>The page token of the first page retrieved. If null, this retrieves the first page of size <code>PageSize</code>. </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 (ByValue, )" position="1"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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="False" position="Named"> <name>ProductSource</name> <description> <para>Access level of the source of the product. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProductSource</parameterValue> <type> <name>Amazon.ServiceCatalog.ProductSource</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortBy</name> <description> <para>The sort field specifier. If no value is specified, results are not sorted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.ProductViewSortBy</parameterValue> <type> <name>Amazon.ServiceCatalog.ProductViewSortBy</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortOrder</name> <description> <para>The sort order specifier. If no value is specified, results are not sorted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.SortOrder</parameterValue> <type> <name>Amazon.ServiceCatalog.SortOrder</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.ServiceCatalog.Model.ProductViewDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ProductViewDetail objects. The service call response (type Amazon.ServiceCatalog.Model.SearchProductsAsAdminResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Search-SCProductsAsAdmin.html&tocid=Search-SCProductsAsAdmin</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Unregister-SCPrincipalFromPortfolio</name> <description> <para>Invokes the DisassociatePrincipalFromPortfolio operation against AWS Service Catalog.</para> </description> <verb>Unregister</verb> <noun>SCPrincipalFromPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates a previously associated principal ARN from a specified portfolio. </para> </description> <syntax> <syntaxItem> <name>Unregister-SCPrincipalFromPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PrincipalARN</name> <description> <para>The ARN representing the principal (IAM user, role, or group). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PrincipalARN parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PrincipalARN parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 (ByValue, )" position="1"> <name>PrincipalARN</name> <description> <para>The ARN representing the principal (IAM user, role, or group). </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PrincipalARN parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.DisassociatePrincipalFromPortfolioResponse) 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=Unregister-SCPrincipalFromPortfolio.html&tocid=Unregister-SCPrincipalFromPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Unregister-SCProductFromPortfolio</name> <description> <para>Invokes the DisassociateProductFromPortfolio operation against AWS Service Catalog.</para> </description> <verb>Unregister</verb> <noun>SCProductFromPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates the specified product from the specified portfolio. </para> </description> <syntax> <syntaxItem> <name>Unregister-SCProductFromPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProductId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProductId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>PortfolioId</name> <description> <para>The portfolio identifier. </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 (ByValue, )" position="1"> <name>ProductId</name> <description> <para>The product identifier. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ProductId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServiceCatalog.Model.DisassociateProductFromPortfolioResponse) 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=Unregister-SCProductFromPortfolio.html&tocid=Unregister-SCProductFromPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Update-SCConstraint</name> <description> <para>Invokes the UpdateConstraint operation against AWS Service Catalog.</para> </description> <verb>Update</verb> <noun>SCConstraint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing constraint. </para> </description> <syntax> <syntaxItem> <name>Update-SCConstraint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the constraint to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The updated text description of the constraint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>Description</name> <description> <para>The updated text description of the constraint. </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="False" 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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the constraint to update. </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.ServiceCatalog.Model.UpdateConstraintResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.UpdateConstraintResponse 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=Update-SCConstraint.html&tocid=Update-SCConstraint</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Update-SCPortfolio</name> <description> <para>Invokes the UpdatePortfolio operation against AWS Service Catalog.</para> </description> <verb>Update</verb> <noun>SCPortfolio</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the specified portfolio's details. This operation does not work with a product that has been shared with you. </para> </description> <syntax> <syntaxItem> <name>Update-SCPortfolio</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the portfolio for the update request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AddTag</name> <description> <para>Tags to add to the existing list of tags associated with the portfolio. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The updated text description of the portfolio. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DisplayName</name> <description> <para>The name to use for display purposes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProviderName</name> <description> <para>The updated name of the portfolio provider. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RemoveTag</name> <description> <para>Tags to remove from the existing list of tags associated with the portfolio. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>AddTag</name> <description> <para>Tags to add to the existing list of tags associated with the portfolio. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> <type> <name>Amazon.ServiceCatalog.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The updated text description of the portfolio. </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="False" position="Named"> <name>DisplayName</name> <description> <para>The name to use for display purposes. </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="False" 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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the portfolio for the update request. </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="False" position="Named"> <name>ProviderName</name> <description> <para>The updated name of the portfolio provider. </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="False" position="Named"> <name>RemoveTag</name> <description> <para>Tags to remove from the existing list of tags associated with the portfolio. </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.ServiceCatalog.Model.UpdatePortfolioResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.UpdatePortfolioResponse 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=Update-SCPortfolio.html&tocid=Update-SCPortfolio</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Update-SCProduct</name> <description> <para>Invokes the UpdateProduct operation against AWS Service Catalog.</para> </description> <verb>Update</verb> <noun>SCProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing product. </para> </description> <syntax> <syntaxItem> <name>Update-SCProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the product for the update request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AddTag</name> <description> <para>Tags to add to the existing list of tags associated with the product. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The updated text description of the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Distributor</name> <description> <para>The updated distributor of the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The updated product name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RemoveTag</name> <description> <para>Tags to remove from the existing list of tags associated with the product. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SupportDescription</name> <description> <para>The updated support description for the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SupportEmail</name> <description> <para>The updated support email for the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SupportUrl</name> <description> <para>The updated support URL for the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Owner</name> <description> <para>The updated owner of the product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>AddTag</name> <description> <para>Tags to add to the existing list of tags associated with the product. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.Tag[]</parameterValue> <type> <name>Amazon.ServiceCatalog.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The updated text description of the product. </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="False" position="Named"> <name>Distributor</name> <description> <para>The updated distributor of the product. </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="False" 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 (ByValue, )" position="1"> <name>Id</name> <description> <para>The identifier of the product for the update request. </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="False" position="Named"> <name>Name</name> <description> <para>The updated product name. </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="False" position="Named"> <name>Owner</name> <description> <para>The updated owner of the product. </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="False" position="Named"> <name>RemoveTag</name> <description> <para>Tags to remove from the existing list of tags associated with the product. </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="False" position="Named"> <name>SupportDescription</name> <description> <para>The updated support description for the product. </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="False" position="Named"> <name>SupportEmail</name> <description> <para>The updated support email for the product. </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="False" position="Named"> <name>SupportUrl</name> <description> <para>The updated support URL for the product. </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.ServiceCatalog.Model.UpdateProductResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.UpdateProductResponse 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=Update-SCProduct.html&tocid=Update-SCProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Update-SCProvisionedProduct</name> <description> <para>Invokes the UpdateProvisionedProduct operation against AWS Service Catalog.</para> </description> <verb>Update</verb> <noun>SCProvisionedProduct</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely. You can check the status of this request using the <a>DescribeRecord</a> operation. </para> </description> <syntax> <syntaxItem> <name>Update-SCProvisionedProduct</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProvisionedProductId</name> <description> <para>The identifier of the ProvisionedProduct object to update. Specify either <code>ProvisionedProductName</code> or <code>ProvisionedProductId</code>, but not both. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PathId</name> <description> <para>The identifier of the path to use in the updated ProvisionedProduct object. This value is optional if the product has a default path, and is required if there is more than one path for the specified product. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductId</name> <description> <para>The identifier of the ProvisionedProduct object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisionedProductName</name> <description> <para>The updated name of the ProvisionedProduct object. Specify either <code>ProvisionedProductName</code> or <code>ProvisionedProductId</code>, but not both. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningArtifactId</name> <description> <para>The provisioning artifact identifier for this product. This is sometimes referred to as the product version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProvisioningParameter</name> <description> <para>A list of <code>ProvisioningParameter</code> objects used to update the ProvisionedProduct object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.UpdateProvisioningParameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpdateToken</name> <description> <para>The idempotency token that uniquely identifies the provisioning update request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" 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="False" position="Named"> <name>PathId</name> <description> <para>The identifier of the path to use in the updated ProvisionedProduct object. This value is optional if the product has a default path, and is required if there is more than one path for the specified product. </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="False" position="Named"> <name>ProductId</name> <description> <para>The identifier of the ProvisionedProduct object. </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 (ByValue, )" position="1"> <name>ProvisionedProductId</name> <description> <para>The identifier of the ProvisionedProduct object to update. Specify either <code>ProvisionedProductName</code> or <code>ProvisionedProductId</code>, but not both. </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="False" position="Named"> <name>ProvisionedProductName</name> <description> <para>The updated name of the ProvisionedProduct object. Specify either <code>ProvisionedProductName</code> or <code>ProvisionedProductId</code>, but not both. </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="False" position="Named"> <name>ProvisioningArtifactId</name> <description> <para>The provisioning artifact identifier for this product. This is sometimes referred to as the product version. </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="False" position="Named"> <name>ProvisioningParameter</name> <description> <para>A list of <code>ProvisioningParameter</code> objects used to update the ProvisionedProduct object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServiceCatalog.Model.UpdateProvisioningParameter[]</parameterValue> <type> <name>Amazon.ServiceCatalog.Model.UpdateProvisioningParameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpdateToken</name> <description> <para>The idempotency token that uniquely identifies the provisioning update request. </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.ServiceCatalog.Model.RecordDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RecordDetail object. The service call response (type Amazon.ServiceCatalog.Model.UpdateProvisionedProductResponse) 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=Update-SCProvisionedProduct.html&tocid=Update-SCProvisionedProduct</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Update-SCProvisioningArtifact</name> <description> <para>Invokes the UpdateProvisioningArtifact operation against AWS Service Catalog.</para> </description> <verb>Update</verb> <noun>SCProvisioningArtifact</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing provisioning artifact's information. This operation does not work on a provisioning artifact associated with a product that has been shared with you. </para> </description> <syntax> <syntaxItem> <name>Update-SCProvisioningArtifact</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProvisioningArtifactId</name> <description> <para>The identifier of the provisioning artifact for the update request. This is sometimes referred to as the product version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The updated text description of the provisioning artifact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The updated name of the provisioning artifact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AcceptLanguage</name> <description> <para>The language code. - <code>en</code> - English (default) - <code>jp</code> - Japanese - <code>zh</code> - Chinese </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="False" position="Named"> <name>Description</name> <description> <para>The updated text description of the provisioning artifact. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>The updated name of the provisioning artifact. </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="False" position="Named"> <name>ProductId</name> <description> <para>The product identifier. </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 (ByValue, )" position="1"> <name>ProvisioningArtifactId</name> <description> <para>The identifier of the provisioning artifact for the update request. This is sometimes referred to as the product version. </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.ServiceCatalog.Model.UpdateProvisioningArtifactResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServiceCatalog.Model.UpdateProvisioningArtifactResponse 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=Update-SCProvisioningArtifact.html&tocid=Update-SCProvisioningArtifact</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Update-SCTagOption</name> <description> <para>Invokes the UpdateTagOption operation against AWS Service Catalog.</para> </description> <verb>Update</verb> <noun>SCTagOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing TagOption. </para> </description> <syntax> <syntaxItem> <name>Update-SCTagOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Value</name> <description> <para>The updated value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Active</name> <description> <para>The updated active state. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Id</name> <description> <para>The identifier of the constraint to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Active</name> <description> <para>The updated active state. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Id</name> <description> <para>The identifier of the constraint to update. </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 (ByValue, )" position="1"> <name>Value</name> <description> <para>The updated 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.ServiceCatalog.Model.TagOptionDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TagOptionDetail object. The service call response (type Amazon.ServiceCatalog.Model.UpdateTagOptionResponse) 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=Update-SCTagOption.html&tocid=Update-SCTagOption</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/userguide/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg</uri> </navigationLink> <navigationLink> <linkText>Administrator Guide:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/adminguide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/servicecatalog/latest/dg/API_Reference.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>Get-SMSConnector</name> <description> <para>Invokes the GetConnectors operation against Amazon Server Migration Service.</para> </description> <verb>Get</verb> <noun>SMSConnector</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The GetConnectors API returns a list of connectors that are registered with the Server Migration Service.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SMSConnector</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.ServerMigrationService.Model.Connector</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Connector objects. The service call response (type Amazon.ServerMigrationService.Model.GetConnectorsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SMSConnector.html&tocid=Get-SMSConnector</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>Get-SMSReplicationJob</name> <description> <para>Invokes the GetReplicationJobs operation against Amazon Server Migration Service.</para> </description> <verb>Get</verb> <noun>SMSReplicationJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationJobs.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-SMSReplicationJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.ServerMigrationService.Model.ReplicationJob</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ReplicationJob objects. The service call response (type Amazon.ServerMigrationService.Model.GetReplicationJobsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-SMSReplicationJob.html&tocid=Get-SMSReplicationJob</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>Get-SMSReplicationRun</name> <description> <para>Invokes the GetReplicationRuns operation against Amazon Server Migration Service.</para> </description> <verb>Get</verb> <noun>SMSReplicationRun</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationRuns for a ReplicationJob. </para> </description> <syntax> <syntaxItem> <name>Get-SMSReplicationRun</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.ServerMigrationService.Model.GetReplicationRunsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServerMigrationService.Model.GetReplicationRunsResponse 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-SMSReplicationRun.html&tocid=Get-SMSReplicationRun</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>Get-SMSServer</name> <description> <para>Invokes the GetServers operation against Amazon Server Migration Service.</para> </description> <verb>Get</verb> <noun>SMSServer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The GetServers API returns a list of all servers in your server catalog. For this call to succeed, you must previously have called ImportServerCatalog. </para> </description> <syntax> <syntaxItem> <name>Get-SMSServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.ServerMigrationService.Model.GetServersResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.ServerMigrationService.Model.GetServersResponse 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-SMSServer.html&tocid=Get-SMSServer</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>Import-SMSServerCatalog</name> <description> <para>Invokes the ImportServerCatalog operation against Amazon Server Migration Service.</para> </description> <verb>Import</verb> <noun>SMSServerCatalog</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises. This API call requires connectors to be installed and monitoring all servers you would like imported. This API call returns immediately, but may take some time to retrieve all of the servers. </para> </description> <syntax> <syntaxItem> <name>Import-SMSServerCatalog</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.ServerMigrationService.Model.ImportServerCatalogResponse) 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=Import-SMSServerCatalog.html&tocid=Import-SMSServerCatalog</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>New-SMSReplicationJob</name> <description> <para>Invokes the CreateReplicationJob operation against Amazon Server Migration Service.</para> </description> <verb>New</verb> <noun>SMSReplicationJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS. Call this API to first create a ReplicationJob, which will then schedule periodic ReplicationRuns to replicate your server to AWS. Each ReplicationRun will result in the creation of an AWS AMI. </para> </description> <syntax> <syntaxItem> <name>New-SMSReplicationJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Frequency</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseType</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServerMigrationService.LicenseType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SeedReplicationTime</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>Frequency</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseType</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServerMigrationService.LicenseType</parameterValue> <type> <name>Amazon.ServerMigrationService.LicenseType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>SeedReplicationTime</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.ServerMigrationService.Model.CreateReplicationJobResponse) 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=New-SMSReplicationJob.html&tocid=New-SMSReplicationJob</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-SMSReplicationJob</name> <description> <para>Invokes the DeleteReplicationJob operation against Amazon Server Migration Service.</para> </description> <verb>Remove</verb> <noun>SMSReplicationJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns. This will delete the contents of the S3 bucket used to store SMS artifacts, but will not delete any AMIs created by the SMS service. </para> </description> <syntax> <syntaxItem> <name>Remove-SMSReplicationJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ReplicationJobId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ReplicationJobId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ReplicationJobId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServerMigrationService.Model.DeleteReplicationJobResponse) 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-SMSReplicationJob.html&tocid=Remove-SMSReplicationJob</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-SMSServerCatalog</name> <description> <para>Invokes the DeleteServerCatalog operation against Amazon Server Migration Service.</para> </description> <verb>Remove</verb> <noun>SMSServerCatalog</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be accessible to the Server Migration Service. </para> </description> <syntax> <syntaxItem> <name>Remove-SMSServerCatalog</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.ServerMigrationService.Model.DeleteServerCatalogResponse) 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-SMSServerCatalog.html&tocid=Remove-SMSServerCatalog</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>Start-SMSOnDemandReplicationRun</name> <description> <para>Invokes the StartOnDemandReplicationRun operation against Amazon Server Migration Service.</para> </description> <verb>Start</verb> <noun>SMSOnDemandReplicationRun</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency). This ReplicationRun will start immediately. StartOnDemandReplicationRun is subject to limits on how many on demand ReplicationRuns you may call per 24-hour period. </para> </description> <syntax> <syntaxItem> <name>Start-SMSOnDemandReplicationRun</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.ServerMigrationService.Model.StartOnDemandReplicationRunResponse) 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=Start-SMSOnDemandReplicationRun.html&tocid=Start-SMSOnDemandReplicationRun</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>Unregister-SMSConnector</name> <description> <para>Invokes the DisassociateConnector operation against Amazon Server Migration Service.</para> </description> <verb>Unregister</verb> <noun>SMSConnector</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs. </para> </description> <syntax> <syntaxItem> <name>Unregister-SMSConnector</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConnectorId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConnectorId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConnectorId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConnectorId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ConnectorId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServerMigrationService.Model.DisassociateConnectorResponse) 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=Unregister-SMSConnector.html&tocid=Unregister-SMSConnector</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>Update-SMSReplicationJob</name> <description> <para>Invokes the UpdateReplicationJob operation against Amazon Server Migration Service.</para> </description> <verb>Update</verb> <noun>SMSReplicationJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob. Calling this API will affect the next scheduled ReplicationRun. </para> </description> <syntax> <syntaxItem> <name>Update-SMSReplicationJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Frequency</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseType</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServerMigrationService.LicenseType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextReplicationRunStartTime</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ReplicationJobId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>Frequency</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseType</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ServerMigrationService.LicenseType</parameterValue> <type> <name>Amazon.ServerMigrationService.LicenseType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextReplicationRunStartTime</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ReplicationJobId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>ReplicationJobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>RoleName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ReplicationJobId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ServerMigrationService.Model.UpdateReplicationJobResponse) 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=Update-SMSReplicationJob.html&tocid=Update-SMSReplicationJob</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>Use-STSRoleWithSAML</name> <description> <para>Invokes the AssumeRoleWithSAML operation against AWS Security Token Service.</para> </description> <verb>Use</verb> <noun>STSRoleWithSAML</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of <code>AssumeRoleWithSAML</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. The duration can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. The temporary security credentials created by <code>AssumeRoleWithSAML</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by the intersection of both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This means that both policies must grant the permission for the action to be allowed. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy. Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. <important><para> Calling <code>AssumeRoleWithSAML</code> can result in an entry in your AWS CloudTrail logs. The entry includes the value in the <code>NameID</code> element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (<code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code>). </para></important> For more information, see the following resources: - <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>. - <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html">Creating SAML Identity Providers</a> in the <i>IAM User Guide</i>. - <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html">Configuring a Relying Party and Claims</a> in the <i>IAM User Guide</i>. - <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html">Creating a Role for SAML 2.0 Federation</a> in the <i>IAM User Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Use-STSRoleWithSAML</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the role that the caller is assuming. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>PrincipalArn</name> <description> <para>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SAMLAssertion</name> <description> <para>The base-64 encoded SAML authentication response provided by the IdP. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and Adding Claims</a> in the <i>Using IAM</i> guide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Policy</name> <description> <para>An IAM policy in JSON format. The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>DurationInSeconds</name> <description> <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value. The actual expiration time is whichever value is shorter. This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Region</name> <description> <para>The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud and China (Beijing) has its own endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>DurationInSeconds</name> <description> <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value. The actual expiration time is whichever value is shorter. This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="4"> <name>Policy</name> <description> <para>An IAM policy in JSON format. The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </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="False" position="2"> <name>PrincipalArn</name> <description> <para>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. </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="False" position="Named"> <name>Region</name> <description> <para>The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud and China (Beijing) has its own endpoint. </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 (ByValue, )" position="1"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the role that the caller is assuming. </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="False" position="3"> <name>SAMLAssertion</name> <description> <para>The base-64 encoded SAML authentication response provided by the IdP. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and Adding Claims</a> in the <i>Using IAM</i> guide. </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.SecurityToken.Model.AssumeRoleWithSAMLResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse 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=Use-STSRoleWithSAML.html&tocid=Use-STSRoleWithSAML</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</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>Use-STSWebIdentityRole</name> <description> <para>Invokes the AssumeRoleWithWebIdentity operation against AWS Security Token Service.</para> </description> <verb>Use</verb> <noun>STSWebIdentityRole</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para> Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Login with Amazon, Facebook, or Google. <c>AssumeRoleWithWebIdentity</c> is an API call that does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application or by deploying server-based proxy services that use long-term AWS credentials. For more information, see Creating a Mobile Application with Third-Party Sign-In in <i>AWS Security Token Service</i> . The temporary security credentials consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling <c>AssumeRoleWithWebIdentity</c> , which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour. The temporary security credentials that are returned from the <c>AssumeRoleWithWebIdentity</c> response have the permissions that are associated with the access policy of the role being assumed and any policies that are associated with the AWS resource being accessed. You can further restrict the permissions of the temporary security credentials by passing a policy in the request. The resulting permissions are an intersection of both policies. The role's access policy and the policy that you passed are evaluated when calls to AWS service APIs are made using the temporary security credentials. Before your application can call <c>AssumeRoleWithWebIdentity</c> , you must have an identity token from an identity provider and create a role that the application can assume. Typically, to get an identity token, you need to register your application with the identity provider and get a unique application ID from that provider. Also, when you create the role that the application assumes, you must specify the registered identity provider as a principal (establish trust with the identity provider). For more information, see Creating Temporary Security Credentials for Mobile Apps Using Third-Party Identity Providers. </para> </description> <syntax> <syntaxItem> <name>Use-STSWebIdentityRole</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the role that the caller is assuming. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>20 - 2048</description></item></list> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>RoleSessionName</name> <description> <para>An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the <c>AssumedRoleUser</c> response element. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>2 - 32</description></item><item><term>Pattern</term><description>[\w+=,.@-]*</description></item></list> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>WebIdentityToken</name> <description> <para>The OAuth 2.0 access token or OpenID Connect id token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an <c>AssumeRoleWithWebIdentity</c> call. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>ProviderId</name> <description> <para>Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect id tokens, such as <c>accounts.google.com</c>. This is the fully-qualified host component of the domain name of the identity provider. Do not include URL schemes and port numbers. Currently, <c>www.amazon.com</c> and <c>graph.facebook.com</c> are supported. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>Policy</name> <description> <para>A supplemental policy that is associated with the temporary security credentials from the <c>AssumeRoleWithWebIdentity</c> call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>1 - 2048</description></item><item><term>Pattern</term><description>[\u0009\u000A\u000D\u0020-\u00FF]+</description></item></list> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. <b>Constraints:</b><list type="definition"><item><term>Range</term><description>900 - 129600</description></item></list> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Region</name> <description> <para>The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud and China (Beijing) has its own endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. <b>Constraints:</b><list type="definition"><item><term>Range</term><description>900 - 129600</description></item></list> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>Policy</name> <description> <para>A supplemental policy that is associated with the temporary security credentials from the <c>AssumeRoleWithWebIdentity</c> call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>1 - 2048</description></item><item><term>Pattern</term><description>[\u0009\u000A\u000D\u0020-\u00FF]+</description></item></list> </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="False" position="4"> <name>ProviderId</name> <description> <para>Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect id tokens, such as <c>accounts.google.com</c>. This is the fully-qualified host component of the domain name of the identity provider. Do not include URL schemes and port numbers. Currently, <c>www.amazon.com</c> and <c>graph.facebook.com</c> are supported. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list> </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="False" position="Named"> <name>Region</name> <description> <para>The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud and China (Beijing) has its own endpoint. </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 (ByValue, )" position="1"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the role that the caller is assuming. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>20 - 2048</description></item></list> </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="False" position="2"> <name>RoleSessionName</name> <description> <para>An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the <c>AssumedRoleUser</c> response element. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>2 - 32</description></item><item><term>Pattern</term><description>[\w+=,.@-]*</description></item></list> </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="False" position="3"> <name>WebIdentityToken</name> <description> <para>The OAuth 2.0 access token or OpenID Connect id token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an <c>AssumeRoleWithWebIdentity</c> call. <b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list> </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.SecurityToken.Model.AssumeRoleWithWebIdentityResult</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResult instance. The service response (type Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse) is added 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=Use-STSWebIdentityRole.html&tocid=Use-STSWebIdentityRole</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Use-STSWebIdentityRole -DurationInSeconds 3600 -ProviderId "www.amazon.com" -RoleSessionName "app1" -RoleArn "arn:aws:iam::123456789012:role/FederatedWebIdentityRole" -WebIdentityToken "Atza...DVI0r1"</code><remarks><para>Description</para><para>-----------</para><para>Returns a temporary set of credentials, valid for one hour, for a user who has been authenticated with the Login with Amazon identity provider. The credentials assume the access policy associated with the role identified by the role ARN. Optionally, you can pass a JSON policy to the -Policy parameter that further refine the access permissions (you cannot grant more permissions than are available in the permissions associated with the role). The value supplied to the -WebIdentityToken is the unique user identifier that was returned by the identity provider. </para><para /><para /></remarks> </example> </examples> </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>Convert-STSAuthorizationMessage</name> <description> <para>Invokes the DecodeAuthorizationMessage operation against AWS Security Token Service.</para> </description> <verb>Convert</verb> <noun>STSAuthorizationMessage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. For example, if a user is not authorized to perform an action that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure. Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code. The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action. The decoded message includes the following type of information: - Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in the <i>IAM User Guide</i>. - The principal who made the request. - The requested action. - The requested resource. - The values of condition keys in the context of the user's request. </para> </description> <syntax> <syntaxItem> <name>Convert-STSAuthorizationMessage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>EncodedMessage</name> <description> <para>The encoded message that was returned with the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>EncodedMessage</name> <description> <para>The encoded message that was returned with the response. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse) 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=Convert-STSAuthorizationMessage.html&tocid=Convert-STSAuthorizationMessage</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Convert-STSAuthorizationMessage -EncodedMessage "...encoded message..."</code><remarks><para>Description</para><para>-----------</para><para>Decodes the additional information contained in the supplied encoded message content that was returned in response to a request. The additional information is encoded because details of the authorization status can constitute privileged information that the user who requested the action should not see.</para><para /><para /></remarks> </example> </examples> </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>Get-STSCallerIdentity</name> <description> <para>Invokes the GetCallerIdentity operation against AWS Security Token Service.</para> </description> <verb>Get</verb> <noun>STSCallerIdentity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns details about the IAM identity whose credentials are used to call the API. </para> </description> <syntax> <syntaxItem> <name>Get-STSCallerIdentity</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.SecurityToken.Model.GetCallerIdentityResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SecurityToken.Model.GetCallerIdentityResponse 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-STSCallerIdentity.html&tocid=Get-STSCallerIdentity</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</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>Get-STSFederationToken</name> <description> <para>Invokes the GetFederationToken operation against AWS Security Token Service.</para> </description> <verb>Get</verb> <noun>STSFederationToken</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the <code>GetFederationToken</code> action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of <code>GetFederationToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. The <code>GetFederationToken</code> action must be called by using the long-term AWS security credentials of an IAM user. You can also call <code>GetFederationToken</code> using the security credentials of an AWS root account, but we do not recommended it. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources that they need access to. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>IAM User Guide</i>. The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, from 900 seconds (15 minutes) up to a maximium of 129600 seconds (36 hours). The default is 43200 seconds (12 hours). Temporary credentials that are obtained by using AWS root account credentials have a maximum duration of 3600 seconds (1 hour). The temporary security credentials created by <code>GetFederationToken</code> can be used to make API calls to any AWS service with the following exceptions: - You cannot use these credentials to call any IAM APIs. - You cannot call any STS APIs except <code>GetCallerIdentity</code>. <b>Permissions</b> The permissions for the temporary security credentials returned by <code>GetFederationToken</code> are determined by a combination of the following: - The policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. - The policy that is passed as a parameter in the call. The passed policy is attached to the temporary security credentials that result from the <code>GetFederationToken</code> API call--that is, to the <i>federated user</i>. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call <code>GetFederationToken</code>. AWS allows the federated user's request only when both the federated user <i><b>and</b></i> the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. A typical use case is that the permissions of the IAM user whose credentials are used to call <code>GetFederationToken</code> are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user. If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </para> </description> <syntax> <syntaxItem> <name>Get-STSFederationToken</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the federated user. The name is used as an identifier for the temporary security credentials (such as <code>Bob</code>). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Policy</name> <description> <para>An IAM policy in JSON format that is passed with the <code>GetFederationToken</code> call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy. If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DurationInSeconds</name> <description> <para>The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DurationInSeconds</name> <description> <para>The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the federated user. The name is used as an identifier for the temporary security credentials (such as <code>Bob</code>). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </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="False" position="2"> <name>Policy</name> <description> <para>An IAM policy in JSON format that is passed with the <code>GetFederationToken</code> call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy. If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. </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.SecurityToken.Model.GetFederationTokenResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SecurityToken.Model.GetFederationTokenResponse 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-STSFederationToken.html&tocid=Get-STSFederationToken</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-STSFederationToken -Name "Bob" -Policy "...JSON policy..." -DurationInSeconds 3600</code><remarks><para>Description</para><para>-----------</para><para>Requests a federated token valid for one hour using "Bob" as the name of the federated user. This name can be used to reference the federated user name in a resource-based policy (such as an Amazon S3 bucket policy). The supplied IAM policy, in JSON format, is used to scope down the permissions that are available to the IAM user. The supplied policy cannot grant more permissions than those granted to the requesting user, with the final permissions for the federated user being the most restrictive set based on the intersection of the passed policy and the IAM user policy.</para><para /><para /></remarks> </example> </examples> </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>Get-STSSessionToken</name> <description> <para>Invokes the GetSessionToken operation against AWS Security Token Service.</para> </description> <verb>Get</verb> <noun>STSSessionToken</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour. The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions: - You cannot call any IAM APIs unless MFA authentication information is included in the request. - You cannot call any STS API <i>except</i><code>AssumeRole</code> or <code>GetCallerIdentity</code>. We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-STSSessionToken</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DurationInSeconds</name> <description> <para>The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SerialNumber</name> <description> <para>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials. The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>TokenCode</name> <description> <para>The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DurationInSeconds</name> <description> <para>The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SerialNumber</name> <description> <para>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials. The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </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="False" position="3"> <name>TokenCode</name> <description> <para>The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </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.SecurityToken.Model.Credentials</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Credentials object. The service call response (type Amazon.SecurityToken.Model.GetSessionTokenResponse) 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-STSSessionToken.html&tocid=Get-STSSessionToken</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\>Get-STSSessionToken AccessKeyId Expiration SecretAccessKey SessionToken ----------- ---------- --------------- ------------ EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN..... </code><remarks><para>Description</para><para>-----------</para><para>Returns an Amazon.RuntimeAWSCredentials instance containing temporary credentials valid for a set period of time. The credentials used to request temporary credentials are inferred from the current shell defaults. To specify other credentials, use the -ProfileName or -AccessKey/-SecretKey parameters.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\>Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile AccessKeyId Expiration SecretAccessKey SessionToken ----------- ---------- --------------- ------------ EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN..... </code><remarks><para>Description</para><para>-----------</para><para>Returns an Amazon.RuntimeAWSCredentials instance containing temporary credentials valid for one hour. The credentials used to make the request are obtained from the specified profile.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> PS C:\>Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile -SerialNumber YourMFADeviceSerialNumber -TokenCode 123456 AccessKeyId Expiration SecretAccessKey SessionToken ----------- ---------- --------------- ------------ EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN..... </code><remarks><para>Description</para><para>-----------</para><para>Returns an Amazon.RuntimeAWSCredentials instance containing temporary credentials valid for one hour using the identification number of the MFA device associated with the account whose credentials are specified in the profile 'myprofilename' and the value provided by the device.</para><para /><para /></remarks> </example> </examples> </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>Use-STSRole</name> <description> <para>Invokes the AssumeRole operation against AWS Security Token Service.</para> </description> <verb>Use</verb> <noun>STSRole</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use <code>AssumeRole</code> for cross-account access or federation. For a comparison of <code>AssumeRole</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <b>Important:</b> You cannot call <code>AssumeRole</code> by using AWS root account credentials; access is denied. You must use credentials for an IAM user or an IAM role to call <code>AssumeRole</code>. For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">IAM Roles (Delegation and Federation)</a> in the <i>IAM User Guide</i>. For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call <code>AssumeRole</code> (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html#sts-introduction">Common Scenarios for Temporary Credentials</a> in the <i>IAM User Guide</i>. The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. The temporary security credentials created by <code>AssumeRole</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role. The user who wants to access the role must also have permissions delegated from the role's administrator. If the user is in a different account than the role, then the user's administrator must attach a policy that allows the user to call AssumeRole on the ARN of the role in the other account. If the user is in the same account as the role, then you can either attach a policy to the user (identical to the previous different account user), or you can add the user as a principal directly in the role's trust policy <b>Using MFA with AssumeRole</b> You can optionally include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>IAM User Guide</i> guide. To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA devices produces. </para> </description> <syntax> <syntaxItem> <name>Use-STSRole</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the role to assume. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>RoleSessionName</name> <description> <para>An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Policy</name> <description> <para>An IAM policy in JSON format. This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, <i>and</i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>DurationInSeconds</name> <description> <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL that Enables Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>ExternalId</name> <description> <para>A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to Use an External ID When Granting Access to Your AWS Resources to a Third Party</a> in the <i>IAM User Guide</i>. The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SerialNumber</name> <description> <para>The identification number of the MFA device that is associated with the user who is making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TokenCode</name> <description> <para>The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or expired, the <code>AssumeRole</code> call returns an "access denied" error. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>DurationInSeconds</name> <description> <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL that Enables Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>ExternalId</name> <description> <para>A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to Use an External ID When Granting Access to Your AWS Resources to a Third Party</a> in the <i>IAM User Guide</i>. The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </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="False" 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="False" position="3"> <name>Policy</name> <description> <para>An IAM policy in JSON format. This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, <i>and</i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </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 (ByValue, )" position="1"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the role to assume. </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="False" position="2"> <name>RoleSessionName</name> <description> <para>An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </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="False" position="Named"> <name>SerialNumber</name> <description> <para>The identification number of the MFA device that is associated with the user who is making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </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="False" position="Named"> <name>TokenCode</name> <description> <para>The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or expired, the <code>AssumeRole</code> call returns an "access denied" error. The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </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.SecurityToken.Model.AssumeRoleResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.SecurityToken.Model.AssumeRoleResponse 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=Use-STSRole.html&tocid=Use-STSRole</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -Policy "...JSON policy..." -DurationInSeconds 3600</code><remarks><para>Description</para><para>-----------</para><para>Returns a set of temporary credentials (access key, secret key and session token) that can be used for one hour to access AWS resources that the requesting user might not normally have access to. The returned credentials have the permissions that are allowed by the access policy of the role being assumed and the policy that was supplied (you cannot use the supplied policy to grant permissions in excess of those defined by the access policy of the role being assumed).</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600</code><remarks><para>Description</para><para>-----------</para><para>Returns a set of temporary credentials, valid for one hour, that have the same permissions that are defined in the access policy of the role being assumed.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -SerialNumber "GAHT12345678" -TokenCode "123456"</code><remarks><para>Description</para><para>-----------</para><para>Returns a set of temporary credentials supplying the serial number and generated token from an MFA associated with the user credentials used to execute the cmdlet.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\>Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -ExternalId "ABC123"</code><remarks><para>Description</para><para>-----------</para><para>Returns a set of temporary credentials that have assumed a role defined in a customer account. For each role that the third party can assume, the customer account must create a role using an identifier that must be passed in the -ExternalId parameter each time the role is assumed.</para><para /><para /></remarks> </example> </examples> </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>Copy-S3Object</name> <description> <para>Invokes the CopyObject operation to copy an existing S3 object to another S3 destination (bucket and/or object), or download a single S3 object to a local file or folder or download object(s) matching a supplied key prefix to a folder.</para> </description> <verb>Copy</verb> <noun>S3Object</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet </para> </description> <syntax> <syntaxItem> <name>Copy-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the source object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key of the single source object to copy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>LocalFile</name> <description> <para>The full path to the local file that will be created. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>Specifies the version of the source object to copy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>Copies the object if it has been modified since the specified time; otherwise returns an error. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Copy-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the source object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key of the single source object to copy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DestinationKey</name> <description> <para>The key for the copy of the source S3 object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>DestinationBucket</name> <description> <para>The name of the bucket that will contain the copied object. If not specified, the copy is to another S3 object in the source bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>Specifies the version of the source object to copy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetadataDirective</name> <description> <para>Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values are COPY or REPLACE. COPY is the default if not specified. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3MetadataDirective</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>Sets the content type of the target object; if not specified an attempt is made to infer it using the destination or source object keys. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the bucket public with read-only permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the bucket public with read-write permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageClass</name> <description> <para>Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3StorageClass</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StandardStorage</name> <description> <para>Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReducedRedundancyStorage</name> <description> <para>Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that doesn’t require the higher level of durability that S3 provides with the STANDARD storage class. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryption</name> <description> <para>Specifies the encryption used on the server to store the content. Allowable values: None, AES256, aws:kms. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WebsiteRedirectLocation</name> <description> <para>If this is set then when a GET request is made from the S3 website endpoint a 301 HTTP status code will be returned indicating a redirect with this value as the redirect location. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Metadata</name> <description> <para>Metadata headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HeaderCollection</name> <description> <para>Response headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagSet</name> <description> <para>One or more tags to apply to the object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ETagToMatch</name> <description> <para>Copies the object if its entity tag (ETag) matches the specified tag; otherwise return a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ETagToNotMatch</name> <description> <para>Copies the object if its entity tag (ETag) is different than the specified Etag; otherwise returns an error. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>Copies the object if it has been modified since the specified time; otherwise returns an error. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopySourceServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm used on the source object with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopySourceServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 used on the source object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopySourceServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 used on the source object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Copy-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the source object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key of the single source object to copy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>Specifies the version of the source object to copy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LocalFolder</name> <description> <para>The path to a local folder that will contain the downloaded object. If a relative path is supplied, it will be resolved to a full path using the current session's location. When copying to a local folder the object key is used as the filename. Note that object keys that are not valid filenames for the host system could cause an exception to be thrown. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>Copies the object if it has been modified since the specified time; otherwise returns an error. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Copy-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the source object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LocalFolder</name> <description> <para>The path to a local folder that will contain the downloaded object. If a relative path is supplied, it will be resolved to a full path using the current session's location. When copying to a local folder the object key is used as the filename. Note that object keys that are not valid filenames for the host system could cause an exception to be thrown. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KeyPrefix</name> <description> <para>Used to download multiple objects to the specified local folder. The supplied prefix will be used to determine the set of objects to download that share the same key prefix. You must specify either this parameter, or the -Key parameter, to determine what object(s) to download. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>Copies the object if it has been modified since the specified time; otherwise returns an error. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>BucketName</name> <description> <para>The name of the bucket containing the source object. </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="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> <type> <name>Amazon.S3.S3CannedACL</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>Sets the content type of the target object; if not specified an attempt is made to infer it using the destination or source object keys. </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="False" position="Named"> <name>CopySourceServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm used on the source object with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionCustomerMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopySourceServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 used on the source object. </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="False" position="Named"> <name>CopySourceServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 used on the source object. This field is optional, the SDK will calculate the MD5 if this is not set. </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="False" position="4"> <name>DestinationBucket</name> <description> <para>The name of the bucket that will contain the copied object. If not specified, the copy is to another S3 object in the source bucket. </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="False" position="3"> <name>DestinationKey</name> <description> <para>The key for the copy of the source S3 object. </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="False" position="Named"> <name>ETagToMatch</name> <description> <para>Copies the object if its entity tag (ETag) matches the specified tag; otherwise return a PreconditionFailed. </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="False" position="Named"> <name>ETagToNotMatch</name> <description> <para>Copies the object if its entity tag (ETag) is different than the specified Etag; otherwise returns an error. </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="False" 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="False" position="Named"> <name>HeaderCollection</name> <description> <para>Response headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key of the single source object to copy. </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="False" position="Named"> <name>KeyPrefix</name> <description> <para>Used to download multiple objects to the specified local folder. The supplied prefix will be used to determine the set of objects to download that share the same key prefix. You must specify either this parameter, or the -Key parameter, to determine what object(s) to download. </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="False" position="3"> <name>LocalFile</name> <description> <para>The full path to the local file that will be created. </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="False" position="Named"> <name>LocalFolder</name> <description> <para>The path to a local folder that will contain the downloaded object. If a relative path is supplied, it will be resolved to a full path using the current session's location. When copying to a local folder the object key is used as the filename. Note that object keys that are not valid filenames for the host system could cause an exception to be thrown. </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="False" position="Named"> <name>Metadata</name> <description> <para>Metadata headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetadataDirective</name> <description> <para>Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values are COPY or REPLACE. COPY is the default if not specified. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3MetadataDirective</parameterValue> <type> <name>Amazon.S3.S3MetadataDirective</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>Copies the object if it has been modified since the specified time; otherwise returns an error. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the bucket public with read-only permissions </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="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the bucket public with read-write permissions </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="False" position="Named"> <name>ReducedRedundancyStorage</name> <description> <para>Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that doesn’t require the higher level of durability that S3 provides with the STANDARD storage class. </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="False" position="Named"> <name>ServerSideEncryption</name> <description> <para>Specifies the encryption used on the server to store the content. Allowable values: None, AES256, aws:kms. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionCustomerMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </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="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </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="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </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="False" position="Named"> <name>StandardStorage</name> <description> <para>Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. </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="False" position="Named"> <name>StorageClass</name> <description> <para>Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3StorageClass</parameterValue> <type> <name>Amazon.S3.S3StorageClass</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagSet</name> <description> <para>One or more tags to apply to the object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> <type> <name>Amazon.S3.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>VersionId</name> <description> <para>Specifies the version of the source object to copy. </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="False" position="Named"> <name>WebsiteRedirectLocation</name> <description> <para>If this is set then when a GET request is made from the S3 website endpoint a 301 HTTP status code will be returned indicating a redirect with this value as the redirect location. </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.S3.Model.CopyObjectResponse or System.IO.FileInfo or System.IO.DirectoryInfo</name> <uri /> <description /> </type> <description> <para>When copying an object to another object in S3 the cmdlet returns an Amazon.S3.Model.CopyObjectResponse instance from the service API call to effect the copy. When copying a single object from S3 to the local file system the cmdlet returns a FileInfo instance representing the local file. When copying multiple objects to a local folder the cmdlet returns a DirectoryInfo instance to the folder. The service response (type Amazon.S3.Model.CopyObjectResponse) is also added to the cmdlet entry in the $AWSHistory stack regardless of S3->S3 or S3->local file copy mode.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Copy-S3Object.html&tocid=Copy-S3Object</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Copy-S3Object -BucketName test-files -Key sample.txt -DestinationKey sample-copy.txt</code><remarks><para>Description</para><para>-----------</para><para>This command copies the object "sample.txt" from bucket "test-files" to the same bucket but with a new key of "sample-copy.txt".</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Copy-S3Object -BucketName test-files -Key sample.txt -DestinationKey sample-copy.txt -DestinationBucket backup-files</code><remarks><para>Description</para><para>-----------</para><para>This command copies the object "sample.txt" from bucket "test-files" to the bucket "backup-files" with a key of "sample-copy.txt".</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Copy-S3Object -BucketName test-files -Key sample.txt -LocalFile local-sample.txt</code><remarks><para>Description</para><para>-----------</para><para>This command downloads the object "sample.txt" from bucket "test-files" to a local file with name "local-sample.txt".</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\>Copy-S3Object -BucketName test-files -Key data/archive.zip -LocalFolder c:\downloads</code><remarks><para>Description</para><para>-----------</para><para>Downloads the single object to the specified file. The downloaded file will be found at c:\downloads\data\archive.zip</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code>PS C:\>Copy-S3Object -BucketName test-files -KeyPrefix data -LocalFolder c:\downloads</code><remarks><para>Description</para><para>-----------</para><para>Downloads all objects that match the specified key prefix to the local folder. The relative key hierarchy will be preserved as subfolders in the overall download location.</para><para /><para /></remarks> </example> </examples> </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>Get-S3Bucket</name> <description> <para>Invokes the ListBuckets operation against Amazon S3.</para> </description> <verb>Get</verb> <noun>S3Bucket</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves one or more S3Bucket instances describing a set of buckets. </para> </description> <syntax> <syntaxItem> <name>Get-S3Bucket</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>If set, returns a single S3Bucket instance mapping to the specified bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>If set, returns a single S3Bucket instance mapping to the specified bucket. </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.S3Bucket</name> <uri /> <description /> </type> <description> <para>The cmdlet returns 0 or more Amazon.S3.Model.S3Bucket instances. The service response (type Amazon.S3.Model.ListBucketsResponse) is added 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-S3Bucket.html&tocid=Get-S3Bucket</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-S3Bucket</code><remarks><para>Description</para><para>-----------</para><para>This command returns all S3 buckets.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-S3Bucket -BucketName test-files</code><remarks><para>Description</para><para>-----------</para><para>This command returns bucket named "test-files"</para><para /><para /></remarks> </example> </examples> </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>Get-S3Object</name> <description> <para>Invokes the ListObjects call to return a collection of S3Object metadata instances describing S3 objects for a specified bucket. Repeated calls are made to retrieve metadata for all objects unless a specific object key or key prefix and instance count limiters are specified.</para> </description> <verb>Get</verb> <noun>S3Object</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves S3Object instances for one or more S3 objects. </para> </description> <syntax> <syntaxItem> <name>Get-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket that holds the S3 object(s). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>KeyPrefix</name> <description> <para>Limits the response to keys which begin with the indicated prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders. If not specified, all objects are processed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Encoding</name> <description> <para>Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.EncodingType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>Marker</name> <description> <para>Indicates where in the bucket to begin listing. The list will only include keys that occur lexicographically after marker. This is convenient for pagination: to get the next page of results use the last key of the current page as the marker. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MaxKey</name> <description> <para>The maximum number of keys to return (the cmdlet might return fewer than this many keys, but will not return more). Amazon S3 limits API calls to retrieve keys to a maximum of 1000 keys per call. If this parameter is specified and exceeds this limit the cmdlet will make multiple calls in batches of 1000 to retrieve up to the specified number of keys (or less, depending on how many objects the bucket contains). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Delimiter</name> <description> <para>Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Get-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket that holds the S3 object(s). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>Key value identifying a single object in S3 to return metadata for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Encoding</name> <description> <para>Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.EncodingType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>BucketName</name> <description> <para>The name of the bucket that holds the S3 object(s). </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>Delimiter</name> <description> <para>Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. </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="False" position="Named"> <name>Encoding</name> <description> <para>Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.EncodingType</parameterValue> <type> <name>Amazon.S3.EncodingType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>Key value identifying a single object in S3 to return metadata for. </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="2"> <name>KeyPrefix</name> <description> <para>Limits the response to keys which begin with the indicated prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders. If not specified, all objects are processed. </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>Marker</name> <description> <para>Indicates where in the bucket to begin listing. The list will only include keys that occur lexicographically after marker. This is convenient for pagination: to get the next page of results use the last key of the current page as the marker. </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>MaxKey</name> <description> <para>The maximum number of keys to return (the cmdlet might return fewer than this many keys, but will not return more). Amazon S3 limits API calls to retrieve keys to a maximum of 1000 keys per call. If this parameter is specified and exceeds this limit the cmdlet will make multiple calls in batches of 1000 to retrieve up to the specified number of keys (or less, depending on how many objects the bucket contains). </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.S3Object</name> <uri /> <description /> </type> <description> <para>This cmdlet returns 0 or more Amazon.S3.Model.S3Object instances. The service response (type Amazon.S3.Model.ListObjectsRequest) is added to the cmdlet entry in the $AWSHistory stack for each call to retrieve output. Additionally, the following properties are added as notes to the response instance: CommonPrefixes, Delimiter, MaxKeys, Prefix, NextMarker and IsTruncated.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-S3Object.html&tocid=Get-S3Object</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-S3Object -BucketName test-files</code><remarks><para>Description</para><para>-----------</para><para>This command retrieves the information about all of the items in the bucket "test-files".</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-S3Object -BucketName test-files -Key sample.txt</code><remarks><para>Description</para><para>-----------</para><para>This command retrieves the information about the item "sample.txt" from bucket "test-files".</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Get-S3Object -BucketName test-files -KeyPrefix sample</code><remarks><para>Description</para><para>-----------</para><para>This command retrieves the information about all items with the prefix "sample" from bucket "test-files".</para><para /><para /></remarks> </example> </examples> </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>Get-S3PreSignedURL</name> <description> <para>Invokes the GetPreSignedURL operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3PreSignedURL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Create a signed URL allowing access to a resource that would usually require authentication. Note that you can pipe an Amazon.S3.Model.S3Object instance to this cmdlet and its members will be used to satisfy the BucketName, Key and optionally VersionId (if an S3ObjectVersion instance is supplied), parameters. </para> </description> <syntax> <syntaxItem> <name>Get-S3PreSignedURL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to create a pre-signed url to, or containing the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key to the object for which a pre-signed url should be created. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResponseHeaderOverrides_CacheControl</name> <description> <para>CacheControl header value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResponseHeaderOverrides_ContentDisposition</name> <description> <para>The ContentDisposition header value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResponseHeaderOverrides_ContentEncoding</name> <description> <para>The ContentEncoding header value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResponseHeaderOverrides_ContentLanguage</name> <description> <para>ContentLanguage header value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>A standard MIME type describing the format of the object data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResponseHeaderOverrides_ContentType</name> <description> <para>A standard MIME type describing the format of the object data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Expire</name> <description> <para>The expiry date and time for the pre-signed url. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResponseHeaderOverrides_Expire</name> <description> <para>Expiry header value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Protocol</name> <description> <para>The requested protocol (http/https) for the pre-signed url. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Protocol</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>The Server-side encryption algorithm to be used with the customer provided key. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionMethod</name> <description> <para>Specifies the encryption used on the server to store the content. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Verb</name> <description> <para>The verb for the pre-signed url. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.HttpVerb</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>Version id for the object that the pre-signed url will reference. If not set, the url will reference the latest version of the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to create a pre-signed url to, or containing the object. </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="False" position="Named"> <name>ContentType</name> <description> <para>A standard MIME type describing the format of the object data. </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="False" position="Named"> <name>Expire</name> <description> <para>The expiry date and time for the pre-signed url. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key to the object for which a pre-signed url should be created. </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="False" position="Named"> <name>Protocol</name> <description> <para>The requested protocol (http/https) for the pre-signed url. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Protocol</parameterValue> <type> <name>Amazon.S3.Protocol</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResponseHeaderOverrides_CacheControl</name> <description> <para>CacheControl header value. </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="False" position="Named"> <name>ResponseHeaderOverrides_ContentDisposition</name> <description> <para>The ContentDisposition header value. </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="False" position="Named"> <name>ResponseHeaderOverrides_ContentEncoding</name> <description> <para>The ContentEncoding header value. </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="False" position="Named"> <name>ResponseHeaderOverrides_ContentLanguage</name> <description> <para>ContentLanguage header value. </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="False" position="Named"> <name>ResponseHeaderOverrides_ContentType</name> <description> <para>A standard MIME type describing the format of the object data. </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="False" position="Named"> <name>ResponseHeaderOverrides_Expire</name> <description> <para>Expiry header value. </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="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>The Server-side encryption algorithm to be used with the customer provided key. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionCustomerMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption. </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="False" position="Named"> <name>ServerSideEncryptionMethod</name> <description> <para>Specifies the encryption used on the server to store the content. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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="False" position="Named"> <name>Verb</name> <description> <para>The verb for the pre-signed url. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.HttpVerb</parameterValue> <type> <name>Amazon.S3.HttpVerb</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>Version id for the object that the pre-signed url will reference. If not set, the url will reference the latest version of the object. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a System.String 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-S3PreSignedURL.html&tocid=Get-S3PreSignedURL</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>New-S3Bucket</name> <description> <para>Invokes the PutBucket operation against Amazon S3.</para> </description> <verb>New</verb> <noun>S3Bucket</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new bucket with the supplied name and permissions. </para> </description> <syntax> <syntaxItem> <name>New-S3Bucket</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name that will be given to the new bucket. This name needs to be unique across Amazon S3. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the bucket public with read-only permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the bucket public with read-write permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>BucketName</name> <description> <para>The name that will be given to the new bucket. This name needs to be unique across Amazon S3. </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="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> <type> <name>Amazon.S3.S3CannedACL</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the bucket public with read-only permissions </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="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the bucket public with read-write permissions </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.S3Bucket</name> <uri /> <description /> </type> <description> <para>Returns an Amazon.S3.Model.S3Bucket instance representing the new bucket. The service response (type Amazon.S3.Model.PutBucketResponse) is added 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=New-S3Bucket.html&tocid=New-S3Bucket</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>New-S3Bucket -BucketName sample-bucket</code><remarks><para>Description</para><para>-----------</para><para>This command creates a new private bucket named "sample-bucket".</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>New-S3Bucket -BucketName sample-bucket -PublicReadWrite</code><remarks><para>Description</para><para>-----------</para><para>This command creates a new bucket named "sample-bucket" with read-write permissions.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>New-S3Bucket -BucketName sample-bucket -PublicReadOnly</code><remarks><para>Description</para><para>-----------</para><para>This command creates a new bucket named "sample-bucket" with read-only permissions.</para><para /><para /></remarks> </example> </examples> </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>Read-S3Object</name> <description> <para>Downloads one or more objects from an S3 bucket to the local file system.</para> </description> <verb>Read</verb> <noun>S3Object</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Downloads an S3 object, optionally including sub-objects, to a local file or folder location. Returns a FileInfo or DirectoryInfo instance to the downloaded file or the containing folder. Note that you can pipe an Amazon.S3.Model.S3Object instance to this cmdlet and its members will be used to satisfy the BucketName, Key and optionally VersionId (if an S3ObjectVersion instance is supplied), parameters. </para> </description> <syntax> <syntaxItem> <name>Read-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Name of the bucket that holds the content to be downloaded </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key that identifies the single object in S3. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>File</name> <description> <para>The full path to the local file that will be created. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Version</name> <description> <para>If specified, the specific version of the S3 object is returned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>If specified, only objects that have been modified since this date will be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>If specified, only objects that have not been modified since this date will be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Read-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Name of the bucket that holds the content to be downloaded </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>KeyPrefix</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.KeyPrefix </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Folder</name> <description> <para>The full path to a local folder; all downloaded content will be placed under this folder, with subfolders maintaining the S3 object key hierarchies. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>If specified, only objects that have been modified since this date will be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>If specified, only objects that have not been modified since this date will be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Read-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Name of the bucket that holds the content to be downloaded </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>File</name> <description> <para>The full path to the local file that will be created. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Folder</name> <description> <para>The full path to a local folder; all downloaded content will be placed under this folder, with subfolders maintaining the S3 object key hierarchies. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>S3Object</name> <description> <para>Amazon.S3.Model.S3Object instance containing the bucketname and key of the object to download. If the supplied object is an Amazon.S3.Model.S3ObjectVersion instance (derived from S3Object), the version of the object to download will be inferred automatically. The object identified by the supplied S3Object can be downloaded to a specific file (by supplying a value for the -File parameter) or to a folder (specified using the -Folder parameter). When downloading to a folder, the object key is used as the filename. Note that object keys that are not valid filenames for the host system could cause an exception to be thrown. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.S3Object</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>If specified, only objects that have been modified since this date will be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>If specified, only objects that have not been modified since this date will be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>BucketName</name> <description> <para>Name of the bucket that holds the content to be downloaded </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="False" position="3"> <name>File</name> <description> <para>The full path to the local file that will be created. </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="False" position="3"> <name>Folder</name> <description> <para>The full path to a local folder; all downloaded content will be placed under this folder, with subfolders maintaining the S3 object key hierarchies. </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 (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key that identifies the single object in S3. </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="2"> <name>KeyPrefix</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.KeyPrefix </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="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>If specified, only objects that have been modified since this date will be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>S3Object</name> <description> <para>Amazon.S3.Model.S3Object instance containing the bucketname and key of the object to download. If the supplied object is an Amazon.S3.Model.S3ObjectVersion instance (derived from S3Object), the version of the object to download will be inferred automatically. The object identified by the supplied S3Object can be downloaded to a specific file (by supplying a value for the -File parameter) or to a folder (specified using the -Folder parameter). When downloading to a folder, the object key is used as the filename. Note that object keys that are not valid filenames for the host system could cause an exception to be thrown. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.S3Object</parameterValue> <type> <name>Amazon.S3.Model.S3Object</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionCustomerMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </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="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </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="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>If specified, only objects that have not been modified since this date will be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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="False" position="4"> <name>Version</name> <description> <para>If specified, the specific version of the S3 object is returned. </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>System.IO.FileInfo instance if reading a single object or System.IO.DirectoryInfo instance for multi-object read.</name> <uri /> <description /> </type> <description> <para>Returns a System.IO.FileInfo instance representing the local file if reading a single object or a System.IO.DirectoryInfo instance to the root parent folder if reading multiple objects.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Read-S3Object.html&tocid=Read-S3Object</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Read-S3Object -BucketName test-files -Key sample.txt -File local-sample.txt</code><remarks><para>Description</para><para>-----------</para><para>This command retrieves item "sample.txt" from bucket "test-files" and saves it to a file named "local-sample.txt" in the current location. The file "local-sample.txt" does not have to exist before this command is called.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Read-S3Object -BucketName test-files -KeyPrefix DIR -Folder Local-DIR</code><remarks><para>Description</para><para>-----------</para><para>This command retrieves virtual directory "DIR" from bucket "test-files" and saves it to a folder named "Local-DIR" in the current location. The folder "Local-DIR" does not have to exist before this command is called.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Get-S3Bucket | ? { $_.BucketName -like '*config*' } | Get-S3Object | ? { $_.Key -like '*.json' } | Read-S3Object -Folder C:\ConfigObjects</code><remarks><para>Description</para><para>-----------</para><para>Downloads all objects with keys ending in '.json' from buckets with 'config' in the bucket name to files in the specified folder. The object keys are used to set the filenames.</para><para /><para /></remarks> </example> </examples> </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-S3Bucket</name> <description> <para>Invokes the DeleteBucket method against Amazon Simple Storage Service. Use the -DeleteBucketContent switch to delete any objects and/or object versions the bucket contains prior to bucket deletion (non-empty buckets cannot be deleted).</para> </description> <verb>Remove</verb> <noun>S3Bucket</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an S3 bucket, optionally deleting remaining bucket content first (non-empty buckets cannot be deleted). </para> </description> <syntax> <syntaxItem> <name>Remove-S3Bucket</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeleteBucketContent</name> <description> <para>If set, all remaining objects and/or object versions in the bucket are deleted proir to the bucket itself being deleted. Default: Off. Buckets that contain objects cannot be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>BucketName</name> <description> <para>The name of the bucket to be deleted. </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="False" position="Named"> <name>DeleteBucketContent</name> <description> <para>If set, all remaining objects and/or object versions in the bucket are deleted proir to the bucket itself being deleted. Default: Off. Buckets that contain objects cannot be deleted. </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="False" 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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.DeleteBucketResponse</name> <uri /> <description /> </type> <description> <para>Returns the service response (type Amazon.S3.Model.DeleteBucketResponse). The service response is also added 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-S3Bucket.html&tocid=Remove-S3Bucket</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-S3Bucket -BucketName test-files -DeleteBucketContent</code><remarks><para>Description</para><para>-----------</para><para>This command removes all objects and object versions from the bucket 'test-files' and then deletes the bucket. The command will prompt for confirmation before proceeding. Add the -Force switch to suppress confirmation. Note that buckets that are not empty cannot be deleted.</para><para /><para /></remarks> </example> </examples> </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-S3MultipartUpload</name> <description> <para>Aborts the multipart uploads that were initiated before the specified date.</para> </description> <verb>Remove</verb> <noun>S3MultipartUpload</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation aborts multipart uploads. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. If you are uploading large files, Write-S3Object cmdlet will use multipart upload to fulfill the request. If a multipart upload is interrupted, Write-S3Object cmdlet will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), Write-S3Object cmdlet will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke the Remove-S3MultipartUploads to abort the incomplete multipart uploads. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Remove-S3MultipartUploads</i>. </para> </description> <syntax> <syntaxItem> <name>Remove-S3MultipartUpload</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing multipart uploads. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DaysBefore</name> <description> <para>The number of days ago that the multipart uploads were initiated. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Remove-S3MultipartUpload</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing multipart uploads. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>InitiatedDate</name> <description> <para>The date before which the multipart uploads were initiated. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>BucketName</name> <description> <para>The name of the bucket containing multipart uploads. </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="False" position="2"> <name>DaysBefore</name> <description> <para>The number of days ago that the multipart uploads were initiated. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="True" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>InitiatedDate</name> <description> <para>The date before which the multipart uploads were initiated. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues /> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-S3MultipartUpload.html&tocid=Remove-S3MultipartUpload</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-S3MultipartUpload -BucketName test-files -DaysBefore 5</code><remarks><para>Description</para><para>-----------</para><para>This command aborts multipart uploads created earlier than 5 days ago.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Remove-S3MultipartUpload -BucketName test-files -InitiatedDate "Thursday, January 02, 2014"</code><remarks><para>Description</para><para>-----------</para><para>This command aborts multipart uploads created earlier than January 2nd, 2014.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Remove-S3MultipartUpload -BucketName test-files -InitiatedDate "2014/01/02 10:45:37"</code><remarks><para>Description</para><para>-----------</para><para>This command aborts multipart uploads created earlier than January 2nd, 2014, 10:45:37.</para><para /><para /></remarks> </example> </examples> </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-S3Object</name> <description> <para>Invokes the DeleteObjects operation against Amazon S3.</para> </description> <verb>Remove</verb> <noun>S3Object</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified object, object version or set of objects from S3. The DeleteObject operation removes the specified object from Amazon S3.Once deleted, there is no method to restore or undelete an object. You can pipe Amazon.S3.Model.S3Object or Amazon.S3.Model.S3ObjectVersion instances to this cmdlet and their members will be used to satisfy the BucketName, Key (and VersionId if an S3ObjectVersion instance is supplied) parameters. <br /><br /><b>Note: </b>When piping a collection of Amazon.S3.Model.S3Object or Amazon.S3.Model.S3ObjectVersion instances to identify the objects to be deleted the cmdlet receives the elements from the piped collection one element at a time and will therefore make one service call per collection element to be deleted. To perform the deletion as a batch with a single call to the service specify the collection as the value of the -InputObject parameter. The -KeyCollection and -KeyAndVersionCollection parameters automatically process as a batch and make a single call to the service to delete all of the objects identified in the collections supplied to the parameters. </para> </description> <syntax> <syntaxItem> <name>Remove-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the object(s) to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The object key identifying the object to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>VersionId</name> <description> <para>Version identifier of the S3 object to be deleted, for buckets with versioning enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SerialNumber</name> <description> <para>Specifies the serial number of the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationValue</name> <description> <para>Specifies the current token/code displayed on the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Remove-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the object(s) to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KeyAndVersionCollection</name> <description> <para>Collection of Amazon.S3.Model.KeyVersion objects describing the S3 objects to be deleted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.KeyVersion[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReportErrorsOnly</name> <description> <para>If set when deleting multiple objects the service response will include only those keys for objects on which the delete operation failed. By default this switch is not set and keys for both successful multi-object deletes and failures are returned in the response. This parameter is used only when deleting multiple objects using the <code>-KeyCollection</code> parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SerialNumber</name> <description> <para>Specifies the serial number of the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationValue</name> <description> <para>Specifies the current token/code displayed on the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Remove-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the object(s) to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KeyCollection</name> <description> <para>Collection of key names describing the S3 objects to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReportErrorsOnly</name> <description> <para>If set when deleting multiple objects the service response will include only those keys for objects on which the delete operation failed. By default this switch is not set and keys for both successful multi-object deletes and failures are returned in the response. This parameter is used only when deleting multiple objects using the <code>-KeyCollection</code> parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SerialNumber</name> <description> <para>Specifies the serial number of the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationValue</name> <description> <para>Specifies the current token/code displayed on the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> <syntaxItem> <name>Remove-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>InputObject</name> <description> <para>Collection of S3Object or S3ObjectVersion instances describing the S3 objects to be deleted. <br /><b>Note: </b>the objects must all belong to the same bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.S3Object[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReportErrorsOnly</name> <description> <para>If set when deleting multiple objects the service response will include only those keys for objects on which the delete operation failed. By default this switch is not set and keys for both successful multi-object deletes and failures are returned in the response. This parameter is used only when deleting multiple objects using the <code>-KeyCollection</code> parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SerialNumber</name> <description> <para>Specifies the serial number of the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationValue</name> <description> <para>Specifies the current token/code displayed on the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthenticationValue</name> <description> <para>Specifies the current token/code displayed on the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </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>BucketName</name> <description> <para>The name of the bucket containing the object(s) to be deleted. </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="False" 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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="Named"> <name>InputObject</name> <description> <para>Collection of S3Object or S3ObjectVersion instances describing the S3 objects to be deleted. <br /><b>Note: </b>the objects must all belong to the same bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.S3Object[]</parameterValue> <type> <name>Amazon.S3.Model.S3Object[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The object key identifying the object to be deleted. </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="False" position="Named"> <name>KeyAndVersionCollection</name> <description> <para>Collection of Amazon.S3.Model.KeyVersion objects describing the S3 objects to be deleted. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.KeyVersion[]</parameterValue> <type> <name>Amazon.S3.Model.KeyVersion[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KeyCollection</name> <description> <para>Collection of key names describing the S3 objects to be deleted. </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="False" position="Named"> <name>ReportErrorsOnly</name> <description> <para>If set when deleting multiple objects the service response will include only those keys for objects on which the delete operation failed. By default this switch is not set and keys for both successful multi-object deletes and failures are returned in the response. This parameter is used only when deleting multiple objects using the <code>-KeyCollection</code> parameter. </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="False" position="Named"> <name>SerialNumber</name> <description> <para>Specifies the serial number of the multi-factor authentication device associated with your AWS Account. This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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="3"> <name>VersionId</name> <description> <para>Version identifier of the S3 object to be deleted, for buckets with versioning enabled. </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.S3.Model.DeleteObjectResponse</name> <uri /> <description /> </type> <description> <para>When deleting a single object.</para> </description> </returnValue> <returnValue> <type> <name>Amazon.S3.Model.DeleteObjectsResponse</name> <uri /> <description /> </type> <description> <para>When deleting multiple objects.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-S3Object.html&tocid=Remove-S3Object</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-InputObject -BucketName test-files -Key sample.txt</code><remarks><para>Description</para><para>-----------</para><para>This command removes the object "sample.txt" from bucket "test-files". You are prompted for confirmation before the command executes; to suppress the prompt use the <i>-Force</i> switch.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Remove-InputObject -BucketName test-files -Key sample.txt -VersionId HLbxnx6V9omT6AQYVpks8mmFKQcejpqt</code><remarks><para>Description</para><para>-----------</para><para>This command removes the specified version of object "sample.txt" from bucket "test-files", assuming the bucket has been configured to enable object versions.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Remove-InputObject -BucketName test-files -KeyCollection @( "sample1.txt", "sample2.txt", "sample3.txt" )</code><remarks><para>Description</para><para>-----------</para><para>This command removes objects "sample1.txt", "sample2.txt" and "sample3.txt" from bucket "test-files" as a single batch operation. The service response will list all keys processed, regardless of the success or error status of the deletion. To obtain only errors for keys that were not able to be processed by the service add the -ReportErrorsOnly parameter (this parameter can also be specified with the alias <i>-Quiet</i>.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\>Remove-S3Object -bucketname "test-files" -KeyCollection (Get-S3Object "test-files" -KeyPrefix "prefix/subprefix" | select -ExpandProperty Key)</code><remarks><para>Description</para><para>-----------</para><para>This example uses an inline expression with the -KeyCollection parameter to obtain the keys of the objects to delete. Get-S3Object returns a collection of Amazon.S3.Model.S3Object instances, each of which has a Key member of type string identifying the object.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code>PS C:\>Get-InputObject -BucketName "test-files" -KeyPrefix "prefix/subprefix" | Remove-InputObject -Force</code><remarks><para>Description</para><para>-----------</para><para>This example obtains all objects that have a key prefix "prefix/subprefix" in the bucket and deletes them. Note that the incoming objects are processed one at a time. For large collections consider passing the collection to the cmdlet's -InputObject (alias -S3ObjectCollection) parameter to enable the deletion to occur as a batch with a single call to the service.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 6 --------------------------</title><code>PS C:\>(Get-S3Version -BucketName "test-files").Versions | Where {$_.IsDeleteMarker -eq "True"} | Remove-InputObject -Force</code><remarks><para>Description</para><para>-----------</para><para>This example pipes a collection of Amazon.S3.Model.S3ObjectVersion instances that represent delete markers to the cmdlet for deletion. Note that the incoming objects are processed one at a time. For large collections consider passing the collection to the cmdlet's -InputObject (alias -S3ObjectCollection) parameter to enable the deletion to occur as a batch with a single call to the service.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 7 --------------------------</title><code> PS C:\> $keyVersions = @() PS C:\> $markers = (Get-S3Version -BucketName $BucketName).Versions | Where {$_.IsDeleteMarker -eq "True"} PS C:\> foreach ($marker in $markers) { $keyVersions += @{ Key = $marker.Key; VersionId = $marker.VersionId } } PS C:\> Remove-InputObject -BucketName $BucketName -KeyAndVersionCollection $keyVersions -Force </code><remarks><para>Description</para><para>-----------</para><para>This script shows how to perform a batch delete of a set of objects (in this case delete markers) by constructing an array of objects to be used with the -KeyAndVersionCollection parameter.</para><para /><para /></remarks> </example> </examples> </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>Set-S3ACL</name> <description> <para>Invokes the SetACL operation against Amazon S3.</para> </description> <verb>Set</verb> <noun>S3ACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets an S3AccessControlList on the specified bucket or object. Note that you can pipe an Amazon.S3.Model.S3Object instance to this cmdlet and its members will be used to satisfy the BucketName, Key and optionally VersionId (if an S3ObjectVersion instance is supplied), parameters. </para> </description> <syntax> <syntaxItem> <name>Set-S3ACL</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. If an object key is not specified, the ACLs are applied to the bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key of an S3 object. If not specified, the ACLs are applied to the bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>OwnerId</name> <description> <para>The unique identifier of the bucket owner. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>OwnerDisplayName</name> <description> <para>The display name of the bucket owner. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="6"> <name>Grant</name> <description> <para>A collection of grants, where each Grant is a Grantee and a Permission. </para> </description> <parameterValue required="true" variableLength="false">List<Amazon.S3.Model.S3Grant></parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <name>VersionId</name> <description> <para>If set and an object key has been specified, the ACLs are applied to the specific version of the object. This property is ignored if the ACL is to be set on a Bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the bucket public with read-only permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the bucket public with read-write permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>BucketName</name> <description> <para>The name of the bucket. If an object key is not specified, the ACLs are applied to the bucket. </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="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> <type> <name>Amazon.S3.S3CannedACL</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="6"> <name>Grant</name> <description> <para>A collection of grants, where each Grant is a Grantee and a Permission. </para> </description> <parameterValue required="true" variableLength="false">List<Amazon.S3.Model.S3Grant></parameterValue> <type> <name>List<Amazon.S3.Model.S3Grant></name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key of an S3 object. If not specified, the ACLs are applied to the bucket. </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="False" position="5"> <name>OwnerDisplayName</name> <description> <para>The display name of the bucket owner. </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="False" position="4"> <name>OwnerId</name> <description> <para>The unique identifier of the bucket owner. </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="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the bucket public with read-only permissions </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="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the bucket public with read-write permissions </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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="7"> <name>VersionId</name> <description> <para>If set and an object key has been specified, the ACLs are applied to the specific version of the object. This property is ignored if the ACL is to be set on a Bucket. </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>String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns the version ID of the S3 object. The service response (type Amazon.S3.Model.SetACLResponse) is added to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as notes to the response: Headers of type System.Net.WebHeaderCollection</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Set-S3ACL.html&tocid=Set-S3ACL</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Test-S3Bucket</name> <description> <para>Tests that an S3 bucket exists.</para> </description> <verb>Test</verb> <noun>S3Bucket</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Tests that an S3 Bucket exists </para> </description> <syntax> <syntaxItem> <name>Test-S3Bucket</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to test existence and access. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>BucketName</name> <description> <para>The name of the bucket to test existence and access. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>System.Boolean</name> <uri /> <description /> </type> <description> <para>Returns true if the bucket exists, false if it doesn't. Returns true even if the bucket exists but belongs to a different account.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Test-S3Bucket.html&tocid=Test-S3Bucket</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Test-S3Bucket -BucketName test-files</code><remarks><para>Description</para><para>-----------</para><para>This command returns True if the bucket exists, False otherwise. The command returns True even if the bucket does not belong to the user.</para><para /><para /></remarks> </example> </examples> </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>Write-S3Object</name> <description> <para>Uploads one or more files from the local file system to an S3 bucket.</para> </description> <verb>Write</verb> <noun>S3Object</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Uploads a local file, text content or a folder hierarchy of files to Amazon S3, placing them into the specified bucket using the specified key (single object) or key prefix (multiple objects). If you are uploading large files, Write-S3Object cmdlet will use multipart upload to fulfill the request. If a multipart upload is interrupted, Write-S3Object cmdlet will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), Write-S3Object cmdlet will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke the Remove-S3MultipartUploads to abort the incomplete multipart uploads. </para> </description> <syntax> <syntaxItem> <name>Write-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket that will hold the uploaded content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key that will be used to identify the object in S3. If the -File parameter is specified, -Key is optional and the object key can be inferred from the filename value supplied to the -File parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>File</name> <description> <para>The full path to the local file to be uploaded. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-only permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-write permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ContentType </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageClass</name> <description> <para>Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3StorageClass</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StandardStorage</name> <description> <para>Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. This parameter is deprecated. Please use the StorageClass parameter instead. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReducedRedundancyStorage</name> <description> <para>Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that does not require the higher level of durability that S3 provides with the STANDARD storage class. This parameter is deprecated. Please use the StorageClass parameter instead. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryption</name> <description> <para>Specifies the encryption used on the server to store the content. Allowable values: None, AES256, aws:kms. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Metadata</name> <description> <para>Metadata headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HeaderCollection</name> <description> <para>Response headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagSet</name> <description> <para>One or more tags to apply to the object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConcurrentServiceRequest</name> <description> <para>This property determines how many active threads will be used to upload the file . This property is only applicable if the file being uploaded is larger than 16 MB, in which case TransferUtility is used to upload multiple parts in parallel. The default value is 10. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <syntaxItem> <name>Write-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket that will hold the uploaded content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key that will be used to identify the object in S3. If the -File parameter is specified, -Key is optional and the object key can be inferred from the filename value supplied to the -File parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Content</name> <description> <para>Specifies text content that will be used to set the content of the object in S3. Use a here-string to specify multiple lines of text. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-only permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-write permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ContentType </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageClass</name> <description> <para>Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3StorageClass</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StandardStorage</name> <description> <para>Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. This parameter is deprecated. Please use the StorageClass parameter instead. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReducedRedundancyStorage</name> <description> <para>Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that does not require the higher level of durability that S3 provides with the STANDARD storage class. This parameter is deprecated. Please use the StorageClass parameter instead. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryption</name> <description> <para>Specifies the encryption used on the server to store the content. Allowable values: None, AES256, aws:kms. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Metadata</name> <description> <para>Metadata headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HeaderCollection</name> <description> <para>Response headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagSet</name> <description> <para>One or more tags to apply to the object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConcurrentServiceRequest</name> <description> <para>This property determines how many active threads will be used to upload the file . This property is only applicable if the file being uploaded is larger than 16 MB, in which case TransferUtility is used to upload multiple parts in parallel. The default value is 10. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <syntaxItem> <name>Write-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket that will hold the uploaded content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key that will be used to identify the object in S3. If the -File parameter is specified, -Key is optional and the object key can be inferred from the filename value supplied to the -File parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Stream</name> <description> <para>The stream to be uploaded. </para> </description> <parameterValue required="true" variableLength="false">System.IO.Stream</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-only permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-write permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ContentType </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageClass</name> <description> <para>Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3StorageClass</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StandardStorage</name> <description> <para>Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. This parameter is deprecated. Please use the StorageClass parameter instead. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReducedRedundancyStorage</name> <description> <para>Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that does not require the higher level of durability that S3 provides with the STANDARD storage class. This parameter is deprecated. Please use the StorageClass parameter instead. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryption</name> <description> <para>Specifies the encryption used on the server to store the content. Allowable values: None, AES256, aws:kms. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Metadata</name> <description> <para>Metadata headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HeaderCollection</name> <description> <para>Response headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagSet</name> <description> <para>One or more tags to apply to the object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConcurrentServiceRequest</name> <description> <para>This property determines how many active threads will be used to upload the file . This property is only applicable if the file being uploaded is larger than 16 MB, in which case TransferUtility is used to upload multiple parts in parallel. The default value is 10. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> <syntaxItem> <name>Write-S3Object</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket that will hold the uploaded content. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>KeyPrefix</name> <description> <para>The common key prefix that will be used for the objects uploaded to S3. Use this parameter when uploading multiple objects. Each object's final key will be of the form 'keyprefix/filename'. To indicate that all content should be uploaded to the root of the bucket, specify a KeyPrefix of '\' or '/'. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Folder</name> <description> <para>The full path to a local folder; all content in the folder will be uploaded to the specified bucket and key. Sub-folders in the folder will only be uploaded if the Recurse switch is specified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Recurse</name> <description> <para>If set, all sub-folders beneath the folder set in LocalFolder will also be uploaded. The folder structure will be mirrored in S3. Defaults off [false]. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>SearchPattern</name> <description> <para>The search pattern used to determine which files in the directory are uploaded. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-only permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-write permissions </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentType</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ContentType </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageClass</name> <description> <para>Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3StorageClass</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StandardStorage</name> <description> <para>Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. This parameter is deprecated. Please use the StorageClass parameter instead. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReducedRedundancyStorage</name> <description> <para>Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that does not require the higher level of durability that S3 provides with the STANDARD storage class. This parameter is deprecated. Please use the StorageClass parameter instead. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryption</name> <description> <para>Specifies the encryption used on the server to store the content. Allowable values: None, AES256, aws:kms. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to encrypt the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Metadata</name> <description> <para>Metadata headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HeaderCollection</name> <description> <para>Response headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagSet</name> <description> <para>One or more tags to apply to the object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConcurrentServiceRequest</name> <description> <para>This property determines how many active threads will be used to upload the file . This property is only applicable if the file being uploaded is larger than 16 MB, in which case TransferUtility is used to upload multiple parts in parallel. The default value is 10. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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>BucketName</name> <description> <para>The name of the bucket that will hold the uploaded content. </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="False" position="Named"> <name>CannedACLName</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CannedACLName </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3CannedACL</parameterValue> <type> <name>Amazon.S3.S3CannedACL</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConcurrentServiceRequest</name> <description> <para>This property determines how many active threads will be used to upload the file . This property is only applicable if the file being uploaded is larger than 16 MB, in which case TransferUtility is used to upload multiple parts in parallel. The default value is 10. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Content</name> <description> <para>Specifies text content that will be used to set the content of the object in S3. Use a here-string to specify multiple lines of text. </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="False" position="Named"> <name>ContentType</name> <description> <para>Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ContentType </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="False" position="3"> <name>File</name> <description> <para>The full path to the local file to be uploaded. </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="False" position="3"> <name>Folder</name> <description> <para>The full path to a local folder; all content in the folder will be uploaded to the specified bucket and key. Sub-folders in the folder will only be uploaded if the Recurse switch is specified. </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="False" 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="False" position="Named"> <name>HeaderCollection</name> <description> <para>Response headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key that will be used to identify the object in S3. If the -File parameter is specified, -Key is optional and the object key can be inferred from the filename value supplied to the -File parameter. </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 (ByPropertyName)" position="2"> <name>KeyPrefix</name> <description> <para>The common key prefix that will be used for the objects uploaded to S3. Use this parameter when uploading multiple objects. Each object's final key will be of the form 'keyprefix/filename'. To indicate that all content should be uploaded to the root of the bucket, specify a KeyPrefix of '\' or '/'. </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="False" position="Named"> <name>Metadata</name> <description> <para>Metadata headers to set on the object. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicReadOnly</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-only permissions </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="False" position="Named"> <name>PublicReadWrite</name> <description> <para>If set, applies an ACL making the S3 object(s) public with read-write permissions </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="False" position="4"> <name>Recurse</name> <description> <para>If set, all sub-folders beneath the folder set in LocalFolder will also be uploaded. The folder structure will be mirrored in S3. Defaults off [false]. </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="False" position="Named"> <name>ReducedRedundancyStorage</name> <description> <para>Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that does not require the higher level of durability that S3 provides with the STANDARD storage class. This parameter is deprecated. Please use the StorageClass parameter instead. </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="False" position="5"> <name>SearchPattern</name> <description> <para>The search pattern used to determine which files in the directory are uploaded. </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="False" position="Named"> <name>ServerSideEncryption</name> <description> <para>Specifies the encryption used on the server to store the content. Allowable values: None, AES256, aws:kms. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionCustomerMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>Specifies base64-encoded encryption key for Amazon S3 to use to encrypt the object. </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="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </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="False" position="Named"> <name>ServerSideEncryptionKeyManagementServiceKeyId</name> <description> <para>Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </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="False" position="Named"> <name>StandardStorage</name> <description> <para>Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. This parameter is deprecated. Please use the StorageClass parameter instead. </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="False" position="Named"> <name>StorageClass</name> <description> <para>Specifies the storage class for the object. Please refer to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> for information on S3 storage classes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.S3StorageClass</parameterValue> <type> <name>Amazon.S3.S3StorageClass</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Stream</name> <description> <para>The stream to be uploaded. </para> </description> <parameterValue required="true" variableLength="false">System.IO.Stream</parameterValue> <type> <name>System.IO.Stream</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagSet</name> <description> <para>One or more tags to apply to the object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> <type> <name>Amazon.S3.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues /> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Write-S3Object.html&tocid=Write-S3Object</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Write-S3Object -BucketName test-files -Key "sample.txt" -File .\local-sample.txt</code><remarks><para>Description</para><para>-----------</para><para>This command uploads the single file "local-sample.txt" to Amazon S3, creating an object with key "sample.txt" in bucket "test-files".</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Write-S3Object -BucketName test-files -File .\sample.txt</code><remarks><para>Description</para><para>-----------</para><para>This command uploads the single file "sample.txt" to Amazon S3, creating an object with key "sample.txt" in bucket "test-files". If the -Key parameter is not supplied, the filename is used as the S3 object key.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\>Write-S3Object -BucketName test-files -Key "prefix/to/sample.txt" -File .\local-sample.txt</code><remarks><para>Description</para><para>-----------</para><para>This command uploads the single file "local-sample.txt" to Amazon S3, creating an object with key "prefix/to/sample.txt" in bucket "test-files".</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\>Write-S3Object -BucketName test-files -Folder .\Scripts -KeyPrefix SampleScripts\</code><remarks><para>Description</para><para>-----------</para><para>This command uploads all files in the subdirectory "Scripts" to the bucket "test-files" and applies the common key prefix "SampleScripts" to each object. Each uploaded file will have a key of "SampleScripts/filename" where 'filename' varies.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code>PS C:\>Write-S3Object -BucketName test-files -Folder .\Scripts -KeyPrefix SampleScripts\ -SearchPattern *.ps1</code><remarks><para>Description</para><para>-----------</para><para>This command uploads all *.ps1 files in the local director "Scripts" to bucket "test-files" and applies the common key prefix "SampleScripts" to each object. Each uploaded file will have a key of "SampleScripts/filename.ps1" where 'filename' varies.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 6 --------------------------</title><code>PS C:\>Write-S3Object -BucketName test-files -Key "sample.txt" -Content "object contents"</code><remarks><para>Description</para><para>-----------</para><para>This command creates a new S3 object containing the specified content string with key 'sample.txt'.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 7 --------------------------</title><code>PS C:\>Write-S3Object -BucketName test-files -File "sample.txt" -TagSet @{Key="key1";Value="value1"},@{Key="key2",Value="value2"}</code><remarks><para>Description</para><para>-----------</para><para>This command uploads the specified file (the filename is used as the key) and applies the specified tags to the new object.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 8 --------------------------</title><code>PS C:\>Write-S3Object -BucketName test-files -Folder . -KeyPrefix "TaggedFiles" -Recurse -TagSet @{Key="key1";Value="value1"},@{Key="key2",Value="value2"}</code><remarks><para>Description</para><para>-----------</para><para>This command recursively uploads the specified folder and applies the specified tags to all the new objects.</para><para /><para /></remarks> </example> </examples> </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>Get-S3ACL</name> <description> <para>Invokes the GetACL operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3ACL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets the access control policy for the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3ACL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be queried or containing the object to be queried. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key of the S3 object to be queried. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be queried or containing the object to be queried. </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="2"> <name>Key</name> <description> <para>The key of the S3 object to be queried. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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="3"> <name>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </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.S3.Model.S3AccessControlList</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a S3AccessControlList object. The service call response (type Amazon.S3.Model.GetACLResponse) 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-S3ACL.html&tocid=Get-S3ACL</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketAccelerateConfiguration</name> <description> <para>Invokes the GetBucketAccelerateConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketAccelerateConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the accelerate configuration of a bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketAccelerateConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.BucketAccelerateStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a BucketAccelerateStatus object. The service call response (type Amazon.S3.Model.GetBucketAccelerateConfigurationResponse) 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-S3BucketAccelerateConfiguration.html&tocid=Get-S3BucketAccelerateConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketAnalyticsConfiguration</name> <description> <para>Invokes the GetBucketAnalyticsConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketAnalyticsConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets an analytics configuration for the bucket (specified by the analytics configuration ID). </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketAnalyticsConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket from which an analytics configuration is retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsId</name> <description> <para>The identifier used to represent an analytics configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsId</name> <description> <para>The identifier used to represent an analytics configuration. </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 (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket from which an analytics configuration is retrieved. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.AnalyticsConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a AnalyticsConfiguration object. The service call response (type Amazon.S3.Model.GetBucketAnalyticsConfigurationResponse) 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-S3BucketAnalyticsConfiguration.html&tocid=Get-S3BucketAnalyticsConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketAnalyticsConfigurationList</name> <description> <para>Invokes the ListBucketAnalyticsConfigurations operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketAnalyticsConfigurationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the analytics configurations for the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketAnalyticsConfigurationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the analytics configurations to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContinuationToken</name> <description> <para>The ContinuationToken that represents a placeholder from where this request should begin. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the analytics configurations to retrieve. </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="False" position="Named"> <name>ContinuationToken</name> <description> <para>The ContinuationToken that represents a placeholder from where this request should begin. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.ListBucketAnalyticsConfigurationsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.S3.Model.ListBucketAnalyticsConfigurationsResponse 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-S3BucketAnalyticsConfigurationList.html&tocid=Get-S3BucketAnalyticsConfigurationList</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketInventoryConfiguration</name> <description> <para>Invokes the GetBucketInventoryConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketInventoryConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an inventory configuration (identified by the inventory ID) from the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketInventoryConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the inventory configuration to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryId</name> <description> <para>The ID used to identify the inventory configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the inventory configuration to retrieve. </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="False" position="Named"> <name>InventoryId</name> <description> <para>The ID used to identify the inventory configuration. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.InventoryConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a InventoryConfiguration object. The service call response (type Amazon.S3.Model.GetBucketInventoryConfigurationResponse) 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-S3BucketInventoryConfiguration.html&tocid=Get-S3BucketInventoryConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketInventoryConfigurationList</name> <description> <para>Invokes the ListBucketInventoryConfigurations operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketInventoryConfigurationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of inventory configurations for the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketInventoryConfigurationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the inventory configurations to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContinuationToken</name> <description> <para>The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the inventory configurations to retrieve. </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="False" position="Named"> <name>ContinuationToken</name> <description> <para>The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.ListBucketInventoryConfigurationsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.S3.Model.ListBucketInventoryConfigurationsResponse 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-S3BucketInventoryConfigurationList.html&tocid=Get-S3BucketInventoryConfigurationList</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketLocation</name> <description> <para>Invokes the GetBucketLocation operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketLocation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the region the bucket resides in. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketLocation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.S3Region</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a S3Region object. The service call response (type Amazon.S3.Model.GetBucketLocationResponse) 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-S3BucketLocation.html&tocid=Get-S3BucketLocation</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketLogging</name> <description> <para>Invokes the GetBucketLogging operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketLogging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketLogging</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to query. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to query. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.S3BucketLoggingConfig</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a S3BucketLoggingConfig object. The service call response (type Amazon.S3.Model.GetBucketLoggingResponse) 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-S3BucketLogging.html&tocid=Get-S3BucketLogging</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketMetricsConfiguration</name> <description> <para>Invokes the GetBucketMetricsConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketMetricsConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketMetricsConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the metrics configuration to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricsId</name> <description> <para>The ID used to identify the metrics configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the metrics configuration to retrieve. </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="False" position="Named"> <name>MetricsId</name> <description> <para>The ID used to identify the metrics configuration. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.MetricsConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a MetricsConfiguration object. The service call response (type Amazon.S3.Model.GetBucketMetricsConfigurationResponse) 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-S3BucketMetricsConfiguration.html&tocid=Get-S3BucketMetricsConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketMetricsConfigurationList</name> <description> <para>Invokes the ListBucketMetricsConfigurations operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketMetricsConfigurationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the metrics configurations for the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketMetricsConfigurationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the metrics configurations to retrieve. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContinuationToken</name> <description> <para>The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the metrics configurations to retrieve. </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="False" position="Named"> <name>ContinuationToken</name> <description> <para>The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.ListBucketMetricsConfigurationsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.S3.Model.ListBucketMetricsConfigurationsResponse 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-S3BucketMetricsConfigurationList.html&tocid=Get-S3BucketMetricsConfigurationList</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketNotification</name> <description> <para>Invokes the GetBucketNotification operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketNotification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the notification configuration of a bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketNotification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.GetBucketNotificationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.S3.Model.GetBucketNotificationResponse 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-S3BucketNotification.html&tocid=Get-S3BucketNotification</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketPolicy</name> <description> <para>Invokes the GetBucketPolicy operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the policy of a specified bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.S3.Model.GetBucketPolicyResponse) 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-S3BucketPolicy.html&tocid=Get-S3BucketPolicy</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketReplication</name> <description> <para>Invokes the GetBucketReplication operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketReplication</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the replication configuration for the given Amazon S3 bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketReplication</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.ReplicationConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ReplicationConfiguration object. The service call response (type Amazon.S3.Model.GetBucketReplicationResponse) 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-S3BucketReplication.html&tocid=Get-S3BucketReplication</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-S3BucketReplication -BucketName mybucket</code><remarks><para>Description</para><para>-----------</para><para>Returns the replication configuration information set on the bucket named 'mybucket'.</para><para /><para /></remarks> </example> </examples> </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>Get-S3BucketRequestPayment</name> <description> <para>Invokes the GetBucketRequestPayment operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketRequestPayment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the request payment configuration of a bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketRequestPayment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.S3.Model.GetBucketRequestPaymentResponse) 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-S3BucketRequestPayment.html&tocid=Get-S3BucketRequestPayment</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-S3BucketRequestPayment -BucketName mybucket</code><remarks><para>Description</para><para>-----------</para><para>Returns the request payment configuration for the bucket named 'mybucket'. By default, the bucket owner pays for downloads from the bucket.</para><para /><para /></remarks> </example> </examples> </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>Get-S3BucketTagging</name> <description> <para>Invokes the GetBucketTagging operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketTagging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the tag set associated with the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketTagging</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be queried. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be queried. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.Tag</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Tag objects. The service call response (type Amazon.S3.Model.GetBucketTaggingResponse) 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-S3BucketTagging.html&tocid=Get-S3BucketTagging</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketVersioning</name> <description> <para>Invokes the GetBucketVersioning operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketVersioning</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the versioning state of a bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketVersioning</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be queried. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be queried. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.S3BucketVersioningConfig</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a S3BucketVersioningConfig object. The service call response (type Amazon.S3.Model.GetBucketVersioningResponse) 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-S3BucketVersioning.html&tocid=Get-S3BucketVersioning</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3BucketWebsite</name> <description> <para>Invokes the GetBucketWebsite operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3BucketWebsite</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the website configuration for a bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3BucketWebsite</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be queried. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be queried. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.WebsiteConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a WebsiteConfiguration object. The service call response (type Amazon.S3.Model.GetBucketWebsiteResponse) 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-S3BucketWebsite.html&tocid=Get-S3BucketWebsite</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3CORSConfiguration</name> <description> <para>Invokes the GetCORSConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3CORSConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the cors configuration for the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3CORSConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.CORSConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CORSConfiguration object. The service call response (type Amazon.S3.Model.GetCORSConfigurationResponse) 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-S3CORSConfiguration.html&tocid=Get-S3CORSConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3LifecycleConfiguration</name> <description> <para>Invokes the GetLifecycleConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3LifecycleConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the lifecycle configuration information set on the bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3LifecycleConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.S3.Model.LifecycleConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a LifecycleConfiguration object. The service call response (type Amazon.S3.Model.GetLifecycleConfigurationResponse) 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-S3LifecycleConfiguration.html&tocid=Get-S3LifecycleConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3ObjectMetadata</name> <description> <para>Invokes the GetObjectMetadata operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3ObjectMetadata</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. </para> </description> <syntax> <syntaxItem> <name>Get-S3ObjectMetadata</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket that contains the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>The key of the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EtagToMatch</name> <description> <para>ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EtagToNotMatch</name> <description> <para>ETag that should not be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PartNumber</name> <description> <para>Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RequestPayer</name> <description> <para>Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.RequestPayer</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>The Server-side encryption algorithm to be used with the customer provided key. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>The base64-encoded encryption key for Amazon S3 to use to decrypt the object Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide. When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you. Important: Amazon S3 does not store the encryption key you provide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket that contains the object. </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="False" position="Named"> <name>EtagToMatch</name> <description> <para>ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned. </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="False" position="Named"> <name>EtagToNotMatch</name> <description> <para>ETag that should not be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned. </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="2"> <name>Key</name> <description> <para>The key of the object. </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="False" position="Named"> <name>ModifiedSinceDate</name> <description> <para>Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PartNumber</name> <description> <para>Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RequestPayer</name> <description> <para>Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.RequestPayer</parameterValue> <type> <name>Amazon.S3.RequestPayer</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerMethod</name> <description> <para>The Server-side encryption algorithm to be used with the customer provided key. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.ServerSideEncryptionCustomerMethod</parameterValue> <type> <name>Amazon.S3.ServerSideEncryptionCustomerMethod</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKey</name> <description> <para>The base64-encoded encryption key for Amazon S3 to use to decrypt the object Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide. When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you. Important: Amazon S3 does not store the encryption key you provide. </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="False" position="Named"> <name>ServerSideEncryptionCustomerProvidedKeyMD5</name> <description> <para>The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. </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="False" position="Named"> <name>UnmodifiedSinceDate</name> <description> <para>Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </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.S3.Model.GetObjectMetadataResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.S3.Model.GetObjectMetadataResponse 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-S3ObjectMetadata.html&tocid=Get-S3ObjectMetadata</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3ObjectTagSet</name> <description> <para>Invokes the GetObjectTagging operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3ObjectTagSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the tag-set of an object. </para> </description> <syntax> <syntaxItem> <name>Get-S3ObjectTagSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>This is the user defined key that identifies the object in the bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BucketName</name> <description> <para>The name of the bucket containing the object tagging. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BucketName</name> <description> <para>The name of the bucket containing the object tagging. </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 (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>This is the user defined key that identifies the object in the bucket. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </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.S3.Model.Tag</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Tag objects. The service call response (type Amazon.S3.Model.GetObjectTaggingResponse) 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-S3ObjectTagSet.html&tocid=Get-S3ObjectTagSet</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-S3Version</name> <description> <para>Invokes the ListVersions operation against Amazon Simple Storage Service.</para> </description> <verb>Get</verb> <noun>S3Version</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns metadata about all of the versions of objects in a bucket. </para> </description> <syntax> <syntaxItem> <name>Get-S3Version</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the objects. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Prefix</name> <description> <para>Limits the response to keys that begin with the specified prefix. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Encoding</name> <description> <para>Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.EncodingType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KeyMarker</name> <description> <para>Specifies the key to start with when listing objects in a bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersionIdMarker</name> <description> <para>Specifies the object version you want to start listing from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Delimiter</name> <description> <para>A delimiter is a character you use to group keys. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxKey</name> <description> <para>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the objects. </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="False" position="Named"> <name>Delimiter</name> <description> <para>A delimiter is a character you use to group keys. </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="False" position="Named"> <name>Encoding</name> <description> <para>Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.EncodingType</parameterValue> <type> <name>Amazon.S3.EncodingType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KeyMarker</name> <description> <para>Specifies the key to start with when listing objects in a bucket. </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="False" position="Named"> <name>MaxKey</name> <description> <para>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Prefix</name> <description> <para>Limits the response to keys that begin with the specified prefix. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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="False" position="Named"> <name>VersionIdMarker</name> <description> <para>Specifies the object version you want to start listing from. </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.S3.Model.ListVersionsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.S3.Model.ListVersionsResponse 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-S3Version.html&tocid=Get-S3Version</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3BucketAnalyticsConfiguration</name> <description> <para>Invokes the DeleteBucketAnalyticsConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3BucketAnalyticsConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). </para> </description> <syntax> <syntaxItem> <name>Remove-S3BucketAnalyticsConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket from which an analytics configuration is deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsId</name> <description> <para>The identifier used to represent an analytics configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsId</name> <description> <para>The identifier used to represent an analytics configuration. </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 (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket from which an analytics configuration is deleted. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteBucketAnalyticsConfigurationResponse) 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-S3BucketAnalyticsConfiguration.html&tocid=Remove-S3BucketAnalyticsConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3BucketInventoryConfiguration</name> <description> <para>Invokes the DeleteBucketInventoryConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3BucketInventoryConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an inventory configuration (identified by the inventory ID) from the bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-S3BucketInventoryConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the inventory configuration to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryId</name> <description> <para>The ID used to identify the inventory configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket containing the inventory configuration to delete. </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="False" 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="False" position="Named"> <name>InventoryId</name> <description> <para>The ID used to identify the inventory configuration. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteBucketInventoryConfigurationResponse) 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-S3BucketInventoryConfiguration.html&tocid=Remove-S3BucketInventoryConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3BucketMetricsConfiguration</name> <description> <para>Invokes the DeleteBucketMetricsConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3BucketMetricsConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-S3BucketMetricsConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket on which Inventory configuration is to be removed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricsId</name> <description> <para>The ID used to identify the metrics configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket on which Inventory configuration is to be removed. </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="False" 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="False" position="Named"> <name>MetricsId</name> <description> <para>The ID used to identify the metrics configuration. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteBucketMetricsConfigurationResponse) 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-S3BucketMetricsConfiguration.html&tocid=Remove-S3BucketMetricsConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3BucketPolicy</name> <description> <para>Invokes the DeleteBucketPolicy operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3BucketPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the policy from the bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-S3BucketPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The bucket on which the policy is to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The bucket on which the policy is to be deleted. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteBucketPolicyResponse) 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-S3BucketPolicy.html&tocid=Remove-S3BucketPolicy</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3BucketReplication</name> <description> <para>Invokes the DeleteBucketReplication operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3BucketReplication</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the replication configuration from the bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-S3BucketReplication</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The bucket on which the replication is to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The bucket on which the replication is to be deleted. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteBucketReplicationResponse) 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-S3BucketReplication.html&tocid=Remove-S3BucketReplication</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-S3BucketReplication -BucketName mybucket</code><remarks><para>Description</para><para>-----------</para><para>Deletes the replication configuration associated with the bucket named 'mybucket'. Note that this operation requires permission for the s3:DeleteReplicationConfiguration action. You will be prompted for confirmation before the operation proceeds - to suppress confirmation, use the -Force switch.</para><para /><para /></remarks> </example> </examples> </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-S3BucketTagging</name> <description> <para>Invokes the DeleteBucketTagging operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3BucketTagging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the tags from the bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-S3BucketTagging</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket on which the tag set is to be removed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket on which the tag set is to be removed. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteBucketTaggingResponse) 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-S3BucketTagging.html&tocid=Remove-S3BucketTagging</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3BucketWebsite</name> <description> <para>Invokes the DeleteBucketWebsite operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3BucketWebsite</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation removes the website configuration from the bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-S3BucketWebsite</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket on which website configuration is to be removed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket on which website configuration is to be removed. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteBucketWebsiteResponse) 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-S3BucketWebsite.html&tocid=Remove-S3BucketWebsite</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3CORSConfiguration</name> <description> <para>Invokes the DeleteCORSConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3CORSConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the cors configuration information set for the bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-S3CORSConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteCORSConfigurationResponse) 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-S3CORSConfiguration.html&tocid=Remove-S3CORSConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3LifecycleConfiguration</name> <description> <para>Invokes the DeleteLifecycleConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3LifecycleConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the lifecycle configuration from the bucket. </para> </description> <syntax> <syntaxItem> <name>Remove-S3LifecycleConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket on which the lifecycle configuration is to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket on which the lifecycle configuration is to be deleted. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.DeleteLifecycleConfigurationResponse) 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-S3LifecycleConfiguration.html&tocid=Remove-S3LifecycleConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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-S3ObjectTagSet</name> <description> <para>Invokes the DeleteObjectTagging operation against Amazon Simple Storage Service.</para> </description> <verb>Remove</verb> <noun>S3ObjectTagSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes the tag-set from an existing object. </para> </description> <syntax> <syntaxItem> <name>Remove-S3ObjectTagSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>The key identifying the object tagging to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BucketName</name> <description> <para>The name of the bucket containing the object tagging to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>The identifier for the specific version of the object to be deleted, if required. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BucketName</name> <description> <para>The name of the bucket containing the object tagging to delete. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>The key identifying the object tagging to delete. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>VersionId</name> <description> <para>The identifier for the specific version of the object to be deleted, if required. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.S3.Model.DeleteObjectTaggingResponse) 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=Remove-S3ObjectTagSet.html&tocid=Remove-S3ObjectTagSet</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Restore-S3Object</name> <description> <para>Invokes the RestoreObject operation against Amazon Simple Storage Service.</para> </description> <verb>Restore</verb> <noun>S3Object</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Restores an archived copy of an object back into Amazon S3 </para> </description> <syntax> <syntaxItem> <name>Restore-S3Object</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>Key</name> <description> <para>This key indicates the S3 object to restore. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>CopyLifetimeInDays</name> <description> <para>Lifetime of the active copy in days </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RequestPayer</name> <description> <para>Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.RequestPayer</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tier</name> <description> <para>Glacier retrieval tier at which the restore will be processed. Glacier related prameters pertaining to this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.GlacierJobTier</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="3"> <name>CopyLifetimeInDays</name> <description> <para>Lifetime of the active copy in days </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="2"> <name>Key</name> <description> <para>This key indicates the S3 object to restore. </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="False" position="Named"> <name>RequestPayer</name> <description> <para>Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.RequestPayer</parameterValue> <type> <name>Amazon.S3.RequestPayer</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tier</name> <description> <para>Glacier retrieval tier at which the restore will be processed. Glacier related prameters pertaining to this job. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.GlacierJobTier</parameterValue> <type> <name>Amazon.S3.GlacierJobTier</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </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.S3.RequestCharged</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a RequestCharged object. The service call response (type Amazon.S3.Model.RestoreObjectResponse) 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=Restore-S3Object.html&tocid=Restore-S3Object</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketAccelerateConfiguration</name> <description> <para>Invokes the PutBucketAccelerateConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketAccelerateConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the accelerate configuration of an existing bucket. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketAccelerateConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to contain the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccelerateConfiguration_Status</name> <description> <para>The accelerate status of the bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.BucketAccelerateStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AccelerateConfiguration_Status</name> <description> <para>The accelerate status of the bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.BucketAccelerateStatus</parameterValue> <type> <name>Amazon.S3.BucketAccelerateStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to contain the object. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketAccelerateConfigurationResponse) 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=Write-S3BucketAccelerateConfiguration.html&tocid=Write-S3BucketAccelerateConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketAnalyticsConfiguration</name> <description> <para>Invokes the PutBucketAnalyticsConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketAnalyticsConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets an analytics configuration for the bucket (specified by the analytics configuration ID). </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketAnalyticsConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to which an analytics configuration is stored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsFilter_AnalyticsFilterPredicate</name> <description> <para>Filter Predicate setup for specific filter types. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.AnalyticsFilterPredicate</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsId</name> <description> <para>The identifier used to represent an analytics configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsConfiguration_AnalyticsId</name> <description> <para>The identifier used to represent an analytics configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_BucketAccountId</name> <description> <para>The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_BucketName</name> <description> <para>The Amazon resource name (ARN) of the bucket to which data is exported. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_Format</name> <description> <para>The file format used when exporting data to Amazon S3. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DataExport_OutputSchemaVersion</name> <description> <para>The version of the output schema to use when exporting data. Must be V_1. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.StorageClassAnalysisSchemaVersion</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_Prefix</name> <description> <para>The prefix to use when exporting data. The exported data begins with this prefix. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsConfiguration_AnalyticsId</name> <description> <para>The identifier used to represent an analytics configuration. </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="False" position="Named"> <name>AnalyticsFilter_AnalyticsFilterPredicate</name> <description> <para>Filter Predicate setup for specific filter types. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.AnalyticsFilterPredicate</parameterValue> <type> <name>Amazon.S3.Model.AnalyticsFilterPredicate</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnalyticsId</name> <description> <para>The identifier used to represent an analytics configuration. </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 (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to which an analytics configuration is stored. </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="False" position="Named"> <name>DataExport_OutputSchemaVersion</name> <description> <para>The version of the output schema to use when exporting data. Must be V_1. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.StorageClassAnalysisSchemaVersion</parameterValue> <type> <name>Amazon.S3.StorageClassAnalysisSchemaVersion</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>S3BucketDestination_BucketAccountId</name> <description> <para>The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data. </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="False" position="Named"> <name>S3BucketDestination_BucketName</name> <description> <para>The Amazon resource name (ARN) of the bucket to which data is exported. </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="False" position="Named"> <name>S3BucketDestination_Format</name> <description> <para>The file format used when exporting data to Amazon S3. </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="False" position="Named"> <name>S3BucketDestination_Prefix</name> <description> <para>The prefix to use when exporting data. The exported data begins with this prefix. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketAnalyticsConfigurationResponse) 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=Write-S3BucketAnalyticsConfiguration.html&tocid=Write-S3BucketAnalyticsConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketInventoryConfiguration</name> <description> <para>Invokes the PutBucketInventoryConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketInventoryConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds an inventory configuration (identified by the inventory ID) from the bucket. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketInventoryConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket where the inventory configuration will be stored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_AccountId</name> <description> <para>The ID of the account that owns the destination bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_BucketName</name> <description> <para>The Amazon resource name (ARN) of the bucket where inventory results will be published. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>Specifies how frequently inventory results are produced. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.InventoryFrequency</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryConfiguration_IncludedObjectVersion</name> <description> <para>Specifies which object version(s) to included in the inventory results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.InventoryIncludedObjectVersions</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryFilter_InventoryFilterPredicate</name> <description> <para>Filter Predicate setup for specific filter types. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.InventoryFilterPredicate</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_InventoryFormat</name> <description> <para>Specifies the output format of the inventory results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.InventoryFormat</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryId</name> <description> <para>Specifies the inventory Id. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryConfiguration_InventoryId</name> <description> <para>The ID used to identify the inventory configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryConfiguration_InventoryOptionalField</name> <description> <para>Contains the optional fields that are included in the inventory results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.InventoryOptionalField[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryConfiguration_IsEnabled</name> <description> <para>Specifies whether the inventory is enabled or disabled. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_Prefix</name> <description> <para>The prefix that is prepended to all inventory results. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket where the inventory configuration will be stored. </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="False" 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="False" position="Named"> <name>InventoryConfiguration_IncludedObjectVersion</name> <description> <para>Specifies which object version(s) to included in the inventory results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.InventoryIncludedObjectVersions</parameterValue> <type> <name>Amazon.S3.InventoryIncludedObjectVersions</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryConfiguration_InventoryId</name> <description> <para>The ID used to identify the inventory configuration. </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="False" position="Named"> <name>InventoryConfiguration_InventoryOptionalField</name> <description> <para>Contains the optional fields that are included in the inventory results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.InventoryOptionalField[]</parameterValue> <type> <name>Amazon.S3.InventoryOptionalField[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryConfiguration_IsEnabled</name> <description> <para>Specifies whether the inventory is enabled or disabled. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryFilter_InventoryFilterPredicate</name> <description> <para>Filter Predicate setup for specific filter types. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.InventoryFilterPredicate</parameterValue> <type> <name>Amazon.S3.Model.InventoryFilterPredicate</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InventoryId</name> <description> <para>Specifies the inventory Id. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>S3BucketDestination_AccountId</name> <description> <para>The ID of the account that owns the destination bucket. </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="False" position="Named"> <name>S3BucketDestination_BucketName</name> <description> <para>The Amazon resource name (ARN) of the bucket where inventory results will be published. </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="False" position="Named"> <name>S3BucketDestination_InventoryFormat</name> <description> <para>Specifies the output format of the inventory results. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.InventoryFormat</parameterValue> <type> <name>Amazon.S3.InventoryFormat</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketDestination_Prefix</name> <description> <para>The prefix that is prepended to all inventory results. </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="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>Specifies how frequently inventory results are produced. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.InventoryFrequency</parameterValue> <type> <name>Amazon.S3.InventoryFrequency</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketInventoryConfigurationResponse) 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=Write-S3BucketInventoryConfiguration.html&tocid=Write-S3BucketInventoryConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketLogging</name> <description> <para>Invokes the PutBucketLogging operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketLogging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketLogging</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingConfig_Grant</name> <description> <para>A collection of grants. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.S3Grant[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingConfig_TargetBucketName</name> <description> <para>Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingConfig_TargetPrefix</name> <description> <para>This element lets you specify a prefix for the keys that the log files will be stored under. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>LoggingConfig_Grant</name> <description> <para>A collection of grants. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.S3Grant[]</parameterValue> <type> <name>Amazon.S3.Model.S3Grant[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LoggingConfig_TargetBucketName</name> <description> <para>Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. </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="False" position="Named"> <name>LoggingConfig_TargetPrefix</name> <description> <para>This element lets you specify a prefix for the keys that the log files will be stored under. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketLoggingResponse) 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=Write-S3BucketLogging.html&tocid=Write-S3BucketLogging</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketMetricsConfiguration</name> <description> <para>Invokes the PutBucketMetricsConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketMetricsConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketMetricsConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket for which the metrics configuration is set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricsFilter_MetricsFilterPredicate</name> <description> <para>Filter Predicate setup for specific filter types. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.MetricsFilterPredicate</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricsId</name> <description> <para>The ID used to identify the metrics configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricsConfiguration_MetricsId</name> <description> <para>The ID used to identify the metrics configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket for which the metrics configuration is set. </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="False" 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="False" position="Named"> <name>MetricsConfiguration_MetricsId</name> <description> <para>The ID used to identify the metrics configuration. </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="False" position="Named"> <name>MetricsFilter_MetricsFilterPredicate</name> <description> <para>Filter Predicate setup for specific filter types. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.MetricsFilterPredicate</parameterValue> <type> <name>Amazon.S3.Model.MetricsFilterPredicate</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MetricsId</name> <description> <para>The ID used to identify the metrics configuration. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketMetricsConfigurationResponse) 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=Write-S3BucketMetricsConfiguration.html&tocid=Write-S3BucketMetricsConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketNotification</name> <description> <para>Invokes the PutBucketNotification operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketNotification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables notifications of specified events for a bucket. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketNotification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LambdaFunctionConfiguration</name> <description> <para>LambdaFunctionConfigurations are configuration for Amazon S3 events to be sent to an Amazon Lambda cloud function. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.LambdaFunctionConfiguration[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QueueConfiguration</name> <description> <para>QueueConfigurations are configuration for Amazon S3 events to be sent to Amazon SQS queues. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.QueueConfiguration[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TopicConfiguration</name> <description> <para>TopicConfigurations are configuration for Amazon S3 events to be sent to Amazon SNS topics. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.TopicConfiguration[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>LambdaFunctionConfiguration</name> <description> <para>LambdaFunctionConfigurations are configuration for Amazon S3 events to be sent to an Amazon Lambda cloud function. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.LambdaFunctionConfiguration[]</parameterValue> <type> <name>Amazon.S3.Model.LambdaFunctionConfiguration[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>QueueConfiguration</name> <description> <para>QueueConfigurations are configuration for Amazon S3 events to be sent to Amazon SQS queues. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.QueueConfiguration[]</parameterValue> <type> <name>Amazon.S3.Model.QueueConfiguration[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TopicConfiguration</name> <description> <para>TopicConfigurations are configuration for Amazon S3 events to be sent to Amazon SNS topics. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.TopicConfiguration[]</parameterValue> <type> <name>Amazon.S3.Model.TopicConfiguration[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketNotificationResponse) 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=Write-S3BucketNotification.html&tocid=Write-S3BucketNotification</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketPolicy</name> <description> <para>Invokes the PutBucketPolicy operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Policy</name> <description> <para>The bucket policy as a JSON document. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContentMD5</name> <description> <para>The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket. </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="False" position="Named"> <name>ContentMD5</name> <description> <para>The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="2"> <name>Policy</name> <description> <para>The bucket policy as a JSON document. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketPolicyResponse) 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=Write-S3BucketPolicy.html&tocid=Write-S3BucketPolicy</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketReplication</name> <description> <para>Invokes the PutBucketReplication operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketReplication</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new replication configuration (or replaces an existing one, if present). </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketReplication</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to have the replication configuration applied. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Configuration_Role</name> <description> <para>Indicates the ARN of the role to assume. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Configuration_Rule</name> <description> <para>Replication rules </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.ReplicationRule[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to have the replication configuration applied. </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="False" position="Named"> <name>Configuration_Role</name> <description> <para>Indicates the ARN of the role to assume. </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="False" position="Named"> <name>Configuration_Rule</name> <description> <para>Replication rules </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.ReplicationRule[]</parameterValue> <type> <name>Amazon.S3.Model.ReplicationRule[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketReplicationResponse) 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=Write-S3BucketReplication.html&tocid=Write-S3BucketReplication</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\>$rule1 = New-Object Amazon.S3.Model.ReplicationRule PS C:\>$rule1.ID = "Rule-1" PS C:\>$rule1.Status = "Enabled" PS C:\>$rule1.Prefix = "TaxDocs" PS C:\>$rule1.Destination = @{ BucketArn = "arn:aws:s3:::exampletargetbucket" } PS C:\>$params = @{ BucketName = "examplebucket" Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3" Configuration_Rule = $rule1 } PS C:\>Write-S3BucketReplication @params </code><remarks><para>Description</para><para>-----------</para><para>This example sets a replication configuration with a single rule enabling replication to the 'exampletargetbucket' bucket any new objects created with the key name prefix "TaxDocs" in the bucket 'examplebucket'.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\>$rule1 = New-Object Amazon.S3.Model.ReplicationRule PS C:\>$rule1.ID = "Rule-1" PS C:\>$rule1.Status = "Enabled" PS C:\>$rule1.Prefix = "TaxDocs" PS C:\>$rule1.Destination = @{ BucketArn = "arn:aws:s3:::exampletargetbucket" } PS C:\>$rule2 = New-Object Amazon.S3.Model.ReplicationRule PS C:\>$rule2.ID = "Rule-2" PS C:\>$rule2.Status = "Enabled" PS C:\>$rule2.Prefix = "OtherDocs" PS C:\>$rule2.Destination = @{ BucketArn = "arn:aws:s3:::exampletargetbucket" } PS C:\>$params = @{ BucketName = "examplebucket" Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3" Configuration_Rule = $rule1,$rule2 } PS C:\>Write-S3BucketReplication @params </code><remarks><para>Description</para><para>-----------</para><para>This example sets a replication configuration with multiple rules enabling replication to the 'exampletargetbucket' bucket any new objects created with either the key name prefix "TaxDocs" or "OtherDocs". The key prefixes must not overlap.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> PS C:\>$rule1 = New-Object Amazon.S3.Model.ReplicationRule PS C:\>$rule1.ID = "Rule-1" PS C:\>$rule1.Status = "Disabled" PS C:\>$rule1.Prefix = "TaxDocs" PS C:\>$rule1.Destination = @{ BucketArn = "arn:aws:s3:::exampletargetbucket" } PS C:\>$params = @{ BucketName = "examplebucket" Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3" Configuration_Rule = $rule1 } PS C:\>Write-S3BucketReplication @params </code><remarks><para>Description</para><para>-----------</para><para>This example updates the replication configuration on the specified bucket to disable the rule controlling replication of objects with the key name prefix "TaxDocs" to the bucket 'exampletargetbucket'.</para><para /><para /></remarks> </example> </examples> </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>Write-S3BucketRequestPayment</name> <description> <para>Invokes the PutBucketRequestPayment operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketRequestPayment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketRequestPayment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to set payment config. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RequestPaymentConfiguration_Payer</name> <description> <para>Specifies who pays for the download and request fees. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to set payment config. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>RequestPaymentConfiguration_Payer</name> <description> <para>Specifies who pays for the download and request fees. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketRequestPaymentResponse) 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=Write-S3BucketRequestPayment.html&tocid=Write-S3BucketRequestPayment</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Write-S3BucketRequestPayment -BucketName mybucket -RequestPaymentConfiguration_Payer Requester</code><remarks><para>Description</para><para>-----------</para><para>Updates the request payment configuration for the bucket named 'mybucket' so that the person requesting downloads from the bucket will be charged for the download. By default the bucket owner pays for downloads. To set the request payment back to the default use 'BucketOwner' for the RequestPaymentConfiguration_Payer parameter.</para><para /><para /></remarks> </example> </examples> </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>Write-S3BucketTagging</name> <description> <para>Invokes the PutBucketTagging operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketTagging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the tags for a bucket. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketTagging</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to apply the tags to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TagSet</name> <description> <para>The collection of tags. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the collection of Tag objects that were added. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to apply the tags to. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the collection of Tag objects that were added. By default, this cmdlet does not generate any output. </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="False" position="2"> <name>TagSet</name> <description> <para>The collection of tags. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> <type> <name>Amazon.S3.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.S3.Model.Tag</name> <uri /> <description /> </type> <description> <para>Returns the collection of Tag objects that were added when you use the PassThru parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketTaggingResponse) 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=Write-S3BucketTagging.html&tocid=Write-S3BucketTagging</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketVersioning</name> <description> <para>Invokes the PutBucketVersioning operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketVersioning</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketVersioning</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be updated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MfaCodes_AuthenticationValue</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersioningConfig_EnableMfaDelete</name> <description> <para>Specifies whether MFA Delete is enabled on this S3 Bucket. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MfaCodes_SerialNumber</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersioningConfig_Status</name> <description> <para>Versioning status for the bucket. Accepted values: Off, Enabled, Suspended. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.VersionStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to be updated. </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="False" 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="False" position="Named"> <name>MfaCodes_AuthenticationValue</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>MfaCodes_SerialNumber</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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="False" position="Named"> <name>VersioningConfig_EnableMfaDelete</name> <description> <para>Specifies whether MFA Delete is enabled on this S3 Bucket. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VersioningConfig_Status</name> <description> <para>Versioning status for the bucket. Accepted values: Off, Enabled, Suspended. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.VersionStatus</parameterValue> <type> <name>Amazon.S3.VersionStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketVersioningResponse) 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=Write-S3BucketVersioning.html&tocid=Write-S3BucketVersioning</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3BucketWebsite</name> <description> <para>Invokes the PutBucketWebsite operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3BucketWebsite</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Set the website configuration for a bucket. </para> </description> <syntax> <syntaxItem> <name>Write-S3BucketWebsite</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to apply the configuration to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WebsiteConfiguration_ErrorDocument</name> <description> <para>The ErrorDocument value, an object key name to use when a 4XX class error occurs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RedirectAllRequestsTo_HostName</name> <description> <para>Name of the host where requests will be redirected. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RedirectAllRequestsTo_HttpRedirectCode</name> <description> <para>The HTTP redirect code to use on the response. Not required if one of the siblings is present. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WebsiteConfiguration_IndexDocumentSuffix</name> <description> <para>This value is a suffix that is appended to a request that is for a "directory" on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RedirectAllRequestsTo_Protocol</name> <description> <para>Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RedirectAllRequestsTo_ReplaceKeyPrefixWith</name> <description> <para>The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RedirectAllRequestsTo_ReplaceKeyWith</name> <description> <para>The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WebsiteConfiguration_RoutingRule</name> <description> <para>The list of routing rules that can be used for configuring redirects if certain conditions are meet. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.RoutingRule[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to apply the configuration to. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>RedirectAllRequestsTo_HostName</name> <description> <para>Name of the host where requests will be redirected. </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="False" position="Named"> <name>RedirectAllRequestsTo_HttpRedirectCode</name> <description> <para>The HTTP redirect code to use on the response. Not required if one of the siblings is present. </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="False" position="Named"> <name>RedirectAllRequestsTo_Protocol</name> <description> <para>Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. </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="False" position="Named"> <name>RedirectAllRequestsTo_ReplaceKeyPrefixWith</name> <description> <para>The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. </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="False" position="Named"> <name>RedirectAllRequestsTo_ReplaceKeyWith</name> <description> <para>The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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="False" position="Named"> <name>WebsiteConfiguration_ErrorDocument</name> <description> <para>The ErrorDocument value, an object key name to use when a 4XX class error occurs. </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="False" position="Named"> <name>WebsiteConfiguration_IndexDocumentSuffix</name> <description> <para>This value is a suffix that is appended to a request that is for a "directory" on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character. </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="False" position="Named"> <name>WebsiteConfiguration_RoutingRule</name> <description> <para>The list of routing rules that can be used for configuring redirects if certain conditions are meet. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.RoutingRule[]</parameterValue> <type> <name>Amazon.S3.Model.RoutingRule[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutBucketWebsiteResponse) 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=Write-S3BucketWebsite.html&tocid=Write-S3BucketWebsite</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3CORSConfiguration</name> <description> <para>Invokes the PutCORSConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3CORSConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the cors configuration for a bucket. </para> </description> <syntax> <syntaxItem> <name>Write-S3CORSConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to have the CORS configuration applied. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Configuration_Rule</name> <description> <para>The collection of rules in this configuration. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.CORSRule[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to have the CORS configuration applied. </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="False" position="Named"> <name>Configuration_Rule</name> <description> <para>The collection of rules in this configuration. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.CORSRule[]</parameterValue> <type> <name>Amazon.S3.Model.CORSRule[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutCORSConfigurationResponse) 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=Write-S3CORSConfiguration.html&tocid=Write-S3CORSConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3LifecycleConfiguration</name> <description> <para>Invokes the PutLifecycleConfiguration operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3LifecycleConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. </para> </description> <syntax> <syntaxItem> <name>Write-S3LifecycleConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to have the lifecycle configuration applied. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Configuration_Rule</name> <description> <para>These rules defined the lifecycle configuration. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.LifecycleRule[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>BucketName</name> <description> <para>The name of the bucket to have the lifecycle configuration applied. </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="False" position="Named"> <name>Configuration_Rule</name> <description> <para>These rules defined the lifecycle configuration. </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.LifecycleRule[]</parameterValue> <type> <name>Amazon.S3.Model.LifecycleRule[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BucketName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.S3.Model.PutLifecycleConfigurationResponse) 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=Write-S3LifecycleConfiguration.html&tocid=Write-S3LifecycleConfiguration</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Write-S3ObjectTagSet</name> <description> <para>Invokes the PutObjectTagging operation against Amazon Simple Storage Service.</para> </description> <verb>Write</verb> <noun>S3ObjectTagSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the supplied tag-set to an object that already exists in a bucket </para> </description> <syntax> <syntaxItem> <name>Write-S3ObjectTagSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>This key is used to identify the object in S3. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BucketName</name> <description> <para>The name of the bucket to contain the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tagging_TagSet</name> <description> <para>TagSet </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BucketName</name> <description> <para>The name of the bucket to contain the object. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>This key is used to identify the object in S3. </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="False" position="Named"> <name>Tagging_TagSet</name> <description> <para>TagSet </para> </description> <parameterValue required="true" variableLength="false">Amazon.S3.Model.Tag[]</parameterValue> <type> <name>Amazon.S3.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseAccelerateEndpoint</name> <description> <para>Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name must be DNS compliant and must not contain periods (.). </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="False" position="Named"> <name>UseDualstackEndpoint</name> <description> <para>Configures the request to Amazon S3 to use the dualstack endpoint for a region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. The dualstack mode of Amazon S3 cannot be used with accelerate mode. </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>VersionId</name> <description> <para>VersionId used to reference a specific version of the object. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.S3.Model.PutObjectTaggingResponse) 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=Write-S3ObjectTagSet.html&tocid=Write-S3ObjectTagSet</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> <navigationLink> <linkText>Getting Started Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/gsg/</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/dev/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonS3/latest/API/</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>Get-R53HostedZonesByName</name> <description> <para>Invokes the ListHostedZonesByName operation against AWS Route 53.</para> </description> <verb>Get</verb> <noun>R53HostedZonesByName</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>To retrieve a list of your hosted zones in lexicographic order, send a <code>GET</code> request to the <code>2013-04-01/hostedzonesbyname</code> resource. The response to this request includes a <code>HostedZones</code> element with zero or more <code>HostedZone</code> child elements lexicographically ordered by DNS name. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the <code>MaxItems</code> parameter. You can use the <code>DNSName</code> and <code>HostedZoneId</code> parameters to control the hosted zone that the list begins with. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100. </para> </description> <syntax> <syntaxItem> <name>Get-R53HostedZonesByName</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DNSName</name> <description> <para>The first name in the lexicographic ordering of domain names that you want the <code>ListHostedZonesByNameRequest</code> request to list. If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker$DNSName</code> and <code>NextMarker$HostedZoneId</code> from the last response in the <code>DNSName</code> and <code>HostedZoneId</code> parameters to get the next page of results. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HostedZoneId</name> <description> <para>If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker$DNSName</code> and <code>NextMarker$HostedZoneId</code> from the last response in the <code>DNSName</code> and <code>HostedZoneId</code> parameters to get the next page of results. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>Specify the maximum number of hosted zones to return per page of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DNSName</name> <description> <para>The first name in the lexicographic ordering of domain names that you want the <code>ListHostedZonesByNameRequest</code> request to list. If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker$DNSName</code> and <code>NextMarker$HostedZoneId</code> from the last response in the <code>DNSName</code> and <code>HostedZoneId</code> parameters to get the next page of results. </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>HostedZoneId</name> <description> <para>If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker$DNSName</code> and <code>NextMarker$HostedZoneId</code> from the last response in the <code>DNSName</code> and <code>HostedZoneId</code> parameters to get the next page of results. </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="False" position="Named"> <name>MaxItem</name> <description> <para>Specify the maximum number of hosted zones to return per page of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.HostedZone</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.Route53.Model.HostedZone objects. The service call response (type Amazon.Route53.Model.ListHostedZonesByNameResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: IsTruncated (type Boolean), Marker (type HostedZonePageMarker), NextMarker (type HostedZonePageMarker), MaxItems (type String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53HostedZonesByName.html&tocid=Get-R53HostedZonesByName</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-R53HostedZonesByName</code><remarks><para>Description</para><para>-----------</para><para>Returns all of your public and private hosted zones in ASCII order by domain name.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-R53HostedZonesByName -DnsName example2.com</code><remarks><para>Description</para><para>-----------</para><para>Returns your public and private hosted zones, in ASCII order by domain name, starting at the specified DNS name.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> Get-R53HostedZonesByName -MaxItem 1 while ($LastServiceResponse.IsTruncated) { $nextPageParams = @{ DnsName=$LastServiceResponse.NextDNSName HostedZoneId=$LastServiceResponse.NextHostedZoneId } Get-R53HostedZonesByName -MaxItem 2 @nextPageParams } </code><remarks><para>Description</para><para>-----------</para><para>This example shows how to manually enumerate the hosted zones by first retrieving a single item and then iterating two at a time until all zones have been returned, using marker properties attached to the service response in the $AWSHistory stack after each call.</para><para /><para /></remarks> </example> </examples> </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>Get-R53TrafficPolicyList</name> <description> <para>Invokes the ListTrafficPolicies operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TrafficPolicyList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about the latest version for every traffic policy that is associated with the current AWS account. To get the information, send a <code>GET</code> request to the <code>2015-01-01/trafficpolicy</code> resource. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the <code>maxitems</code> parameter to list them in groups of up to 100. The response includes three values that help you navigate from one group of <code>maxitems</code> traffic policies to the next: -<b>IsTruncated</b> If the value of <code>IsTruncated</code> in the response is <code>true</code>, there are more traffic policies associated with the current AWS account. If <code>IsTruncated</code> is <code>false</code>, this response includes the last traffic policy that is associated with the current account. -<b>TrafficPolicyIdMarker</b> If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyIdMarker</code> is the ID of the first traffic policy in the next group of <code>MaxItems</code> traffic policies. If you want to list more traffic policies, make another call to <code>ListTrafficPolicies</code>, and specify the value of the <code>TrafficPolicyIdMarker</code> element from the response in the <code>TrafficPolicyIdMarker</code> request parameter. If <code>IsTruncated</code> is <code>false</code>, the <code>TrafficPolicyIdMarker</code> element is omitted from the response. -<b>MaxItems</b> The value that you specified for the <code>MaxItems</code> parameter in the request that produced the current response. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Get-R53TrafficPolicies</i>. </para> </description> <syntax> <syntaxItem> <name>Get-R53TrafficPolicyList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policies to be included in the response body for this request. If you have more than <code>MaxItems</code> traffic policies, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the value of the <code>TrafficPolicyIdMarker</code> element is the ID of the first traffic policy in the next group of <code>MaxItems</code> traffic policies. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyIdMarker</name> <description> <para>For your first request to <code>ListTrafficPolicies</code>, do not include the <code>TrafficPolicyIdMarker</code> parameter. If you have more traffic policies than the value of <code>MaxItems</code>, <code>ListTrafficPolicies</code> returns only the first <code>MaxItems</code> traffic policies. To get the next group of <code>MaxItems</code> policies, submit another request to <code>ListTrafficPolicies</code>. For the value of <code>TrafficPolicyIdMarker</code>, specify the value of the <code>TrafficPolicyIdMarker</code> element that was returned in the previous response. Policies are listed in the order in which they were created. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policies to be included in the response body for this request. If you have more than <code>MaxItems</code> traffic policies, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the value of the <code>TrafficPolicyIdMarker</code> element is the ID of the first traffic policy in the next group of <code>MaxItems</code> traffic policies. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyIdMarker</name> <description> <para>For your first request to <code>ListTrafficPolicies</code>, do not include the <code>TrafficPolicyIdMarker</code> parameter. If you have more traffic policies than the value of <code>MaxItems</code>, <code>ListTrafficPolicies</code> returns only the first <code>MaxItems</code> traffic policies. To get the next group of <code>MaxItems</code> policies, submit another request to <code>ListTrafficPolicies</code>. For the value of <code>TrafficPolicyIdMarker</code>, specify the value of the <code>TrafficPolicyIdMarker</code> element that was returned in the previous response. Policies are listed in the order in which they were created. </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.Route53.Model.TrafficPolicySummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TrafficPolicySummary objects. The service call response (type Amazon.Route53.Model.ListTrafficPoliciesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: IsTruncated (type System.Boolean), TrafficPolicyIdMarker (type System.String), MaxItems (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53TrafficPolicyList.html&tocid=Get-R53TrafficPolicyList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TrafficPolicyVersionList</name> <description> <para>Invokes the ListTrafficPolicyVersions operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TrafficPolicyVersionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about all of the versions for a specified traffic policy. <code>ListTrafficPolicyVersions</code> lists only versions that have not been deleted. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the <code>maxitems</code> parameter to list them in groups of up to 100. The response includes three values that help you navigate from one group of <code>maxitems</code>maxitems traffic policies to the next: -<b>IsTruncated</b> If the value of <code>IsTruncated</code> in the response is <code>true</code>, there are more traffic policy versions associated with the specified traffic policy. If <code>IsTruncated</code> is <code>false</code>, this response includes the last traffic policy version that is associated with the specified traffic policy. -<b>TrafficPolicyVersionMarker</b> The ID of the next traffic policy version that is associated with the current AWS account. If you want to list more traffic policies, make another call to <code>ListTrafficPolicyVersions</code>, and specify the value of the <code>TrafficPolicyVersionMarker</code> element in the <code>TrafficPolicyVersionMarker</code> request parameter. If <code>IsTruncated</code> is <code>false</code>, Amazon Route 53 omits the <code>TrafficPolicyVersionMarker</code> element from the response. -<b>MaxItems</b> The value that you specified for the <code>MaxItems</code> parameter in the request that produced the current response. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Get-R53TrafficPolicyVersions</i>. </para> </description> <syntax> <syntaxItem> <name>Get-R53TrafficPolicyVersionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>Specify the value of <code>Id</code> of the traffic policy for which you want to list all versions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than <code>MaxItems</code> versions, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the value of the <code>TrafficPolicyVersionMarker</code> element is the ID of the first version in the next group of <code>MaxItems</code> traffic policy versions. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyVersionMarker</name> <description> <para>For your first request to <code>ListTrafficPolicyVersions</code>, do not include the <code>TrafficPolicyVersionMarker</code> parameter. If you have more traffic policy versions than the value of <code>MaxItems</code>, <code>ListTrafficPolicyVersions</code> returns only the first group of <code>MaxItems</code> versions. To get the next group of <code>MaxItems</code> traffic policy versions, submit another request to <code>ListTrafficPolicyVersions</code>. For the value of <code>TrafficPolicyVersionMarker</code>, specify the value of the <code>TrafficPolicyVersionMarker</code> element that was returned in the previous response. Traffic policy versions are listed in sequential order. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>Specify the value of <code>Id</code> of the traffic policy for which you want to list all versions. </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="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than <code>MaxItems</code> versions, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the value of the <code>TrafficPolicyVersionMarker</code> element is the ID of the first version in the next group of <code>MaxItems</code> traffic policy versions. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyVersionMarker</name> <description> <para>For your first request to <code>ListTrafficPolicyVersions</code>, do not include the <code>TrafficPolicyVersionMarker</code> parameter. If you have more traffic policy versions than the value of <code>MaxItems</code>, <code>ListTrafficPolicyVersions</code> returns only the first group of <code>MaxItems</code> versions. To get the next group of <code>MaxItems</code> traffic policy versions, submit another request to <code>ListTrafficPolicyVersions</code>. For the value of <code>TrafficPolicyVersionMarker</code>, specify the value of the <code>TrafficPolicyVersionMarker</code> element that was returned in the previous response. Traffic policy versions are listed in sequential order. </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.Route53.Model.TrafficPolicy</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TrafficPolicy objects. The service call response (type Amazon.Route53.Model.ListTrafficPolicyVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: IsTruncated (type System.Boolean), TrafficPolicyVersionMarker (type System.String), MaxItems (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53TrafficPolicyVersionList.html&tocid=Get-R53TrafficPolicyVersionList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53HealthCheck</name> <description> <para>Invokes the UpdateHealthCheck operation against Amazon Route 53.</para> </description> <verb>Update</verb> <noun>R53HealthCheck</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This action updates an existing health check. To update a health check, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i></code> resource. The request body must include a document with an <code>UpdateHealthCheckRequest</code> element. The response returns an <code>UpdateHealthCheckResponse</code> element, which contains metadata about the health check. </para> </description> <syntax> <syntaxItem> <name>Update-R53HealthCheck</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The ID of the health check to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChildHealthCheck</name> <description> <para>For a specified parent health check, a list of <code>HealthCheckId</code> values for the associated child health checks. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableSNI</name> <description> <para>Specify whether you want Amazon Route 53 to send the value of <code>FullyQualifiedDomainName</code> to the endpoint in the <code>client_hello</code> message during TLS negotiation. If you don't specify a value for <code>EnableSNI</code>, Amazon Route 53 defaults to <code>true</code> when <code>Type</code> is <code>HTTPS</code> or <code>HTTPS_STR_MATCH</code> and defaults to <code>false</code> when <code>Type</code> is any other value. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FailureThreshold</name> <description> <para>The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FullyQualifiedDomainName</name> <description> <para>Fully qualified domain name of the instance to be health checked. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckVersion</name> <description> <para>Optional. When you specify a health check version, Amazon Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using <code>HealthCheckVersion</code> lets you prevent overwriting another change to the health check. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthThreshold</name> <description> <para>The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InsufficientDataHealthStatus</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.InsufficientDataHealthStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Inverted</name> <description> <para>A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but <code>Inverted</code> is <code>True</code>, then Amazon Route 53 considers the health check to be unhealthy. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IPAddress</name> <description> <para>The IP address of the resource that you want to check. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AlarmIdentifier_Name</name> <description> <para>The name of the CloudWatch alarm. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port on which you want Amazon Route 53 to open a connection to perform health checks. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AlarmIdentifier_Region</name> <description> <para>The <code>CloudWatchRegion</code> that the CloudWatch alarm was created in. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.CloudWatchRegion</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckRegion</name> <description> <para>A list of <code>HealthCheckRegion</code> values that specify the Amazon EC2 regions that you want Amazon Route 53 to use to perform health checks. You must specify at least three regions. When you remove a region from the list, Amazon Route 53 will briefly continue to check your endpoint from that region. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourcePath</name> <description> <para>The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SearchString</name> <description> <para>If the value of <code>Type</code> is <code>HTTP_STR_MATCH</code> or <code>HTTP_STR_MATCH</code>, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for <code>SearchString</code> in the response body. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AlarmIdentifier_Name</name> <description> <para>The name of the CloudWatch alarm. </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="False" position="Named"> <name>AlarmIdentifier_Region</name> <description> <para>The <code>CloudWatchRegion</code> that the CloudWatch alarm was created in. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.CloudWatchRegion</parameterValue> <type> <name>Amazon.Route53.CloudWatchRegion</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChildHealthCheck</name> <description> <para>For a specified parent health check, a list of <code>HealthCheckId</code> values for the associated child health checks. Specify this value only if you want to change it. </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="False" position="Named"> <name>EnableSNI</name> <description> <para>Specify whether you want Amazon Route 53 to send the value of <code>FullyQualifiedDomainName</code> to the endpoint in the <code>client_hello</code> message during TLS negotiation. If you don't specify a value for <code>EnableSNI</code>, Amazon Route 53 defaults to <code>true</code> when <code>Type</code> is <code>HTTPS</code> or <code>HTTPS_STR_MATCH</code> and defaults to <code>false</code> when <code>Type</code> is any other value. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FailureThreshold</name> <description> <para>The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>FullyQualifiedDomainName</name> <description> <para>Fully qualified domain name of the instance to be health checked. Specify this value only if you want to change it. </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 (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The ID of the health check to update. </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="False" position="Named"> <name>HealthCheckRegion</name> <description> <para>A list of <code>HealthCheckRegion</code> values that specify the Amazon EC2 regions that you want Amazon Route 53 to use to perform health checks. You must specify at least three regions. When you remove a region from the list, Amazon Route 53 will briefly continue to check your endpoint from that region. Specify this value only if you want to change it. </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="False" position="Named"> <name>HealthCheckVersion</name> <description> <para>Optional. When you specify a health check version, Amazon Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using <code>HealthCheckVersion</code> lets you prevent overwriting another change to the health check. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthThreshold</name> <description> <para>The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InsufficientDataHealthStatus</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.InsufficientDataHealthStatus</parameterValue> <type> <name>Amazon.Route53.InsufficientDataHealthStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Inverted</name> <description> <para>A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but <code>Inverted</code> is <code>True</code>, then Amazon Route 53 considers the health check to be unhealthy. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IPAddress</name> <description> <para>The IP address of the resource that you want to check. Specify this value only if you want to change it. </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="False" position="Named"> <name>Port</name> <description> <para>The port on which you want Amazon Route 53 to open a connection to perform health checks. Specify this value only if you want to change it. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourcePath</name> <description> <para>The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. Specify this value only if you want to change it. </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="False" position="Named"> <name>SearchString</name> <description> <para>If the value of <code>Type</code> is <code>HTTP_STR_MATCH</code> or <code>HTTP_STR_MATCH</code>, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for <code>SearchString</code> in the response body. Specify this value only if you want to change it. </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.Route53.Model.HealthCheck</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a HealthCheck object. The service call response (type Amazon.Route53.Model.UpdateHealthCheckResponse) 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=Update-R53HealthCheck.html&tocid=Update-R53HealthCheck</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Edit-R53ResourceRecordSet</name> <description> <para>Invokes the ChangeResourceRecordSets operation against Amazon Route 53.</para> </description> <verb>Edit</verb> <noun>R53ResourceRecordSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use <code>ChangeResourceRecordSets</code> to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44. <b>Change Batches and Transactional Changes</b> The request body must include a document with a <code>ChangeResourceRecordSetsRequest</code> element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Amazon Route 53 either makes all or none of the changes in a change batch request. This ensures that Amazon Route 53 never partially implements the intended changes to the resource record sets in a hosted zone. For example, a change batch request that deletes the <code>CNAME</code> record for www.example.com and creates an alias resource record set for www.example.com. Amazon Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the <code>DELETE</code> or the <code>CREATE</code> action fails, then both changes (plus any other changes in the batch) fail, and the original <code>CNAME</code> record continues to exist. <important><para> Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Amazon Route 53 returns an <code>InvalidChangeBatch</code> error. </para></important> <b>Traffic Flow</b> To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Amazon Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html">Using Traffic Flow to Route DNS Traffic</a> in the <i>Amazon Route 53 Developer Guide</i>. <b>Create, Delete, and Upsert</b> Use <code>ChangeResourceRecordsSetsRequest</code> to perform the following actions: - <code>CREATE</code>: Creates a resource record set that has the specified values. - <code>DELETE</code>: Deletes an existing resource record set that has the specified values. - <code>UPSERT</code>: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Amazon Route 53 updates it with the values in the request. <b>Syntaxes for Creating, Updating, and Deleting Resource Record Sets</b> The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. For an example for each type of resource record set, see "Examples." Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using <code>ChangeResourceRecordSets</code>. <b>Change Propagation to Amazon Route 53 DNS Servers</b> When you submit a <code>ChangeResourceRecordSets</code> request, Amazon Route 53 propagates your changes to all of the Amazon Route 53 authoritative DNS servers. While your changes are propagating, <code>GetChange</code> returns a status of <code>PENDING</code>. When propagation is complete, <code>GetChange</code> returns a status of <code>INSYNC</code>. Changes generally propagate to all Amazon Route 53 name servers within 60 seconds. For more information, see <a>GetChange</a>. <b>Limits on ChangeResourceRecordSets Requests</b> For information about the limits on a <code>ChangeResourceRecordSets</code> request, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html">Limits</a> in the <i>Amazon Route 53 Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Edit-R53ResourceRecordSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that contains the resource record sets that you want to change. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ChangeBatch_Comment</name> <description> <para><i>Optional:</i> Any comments you want to include about a change batch request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>ChangeBatch_Change</name> <description> <para>Information about the changes to make to the record sets. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.Model.Change[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>ChangeBatch_Change</name> <description> <para>Information about the changes to make to the record sets. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.Model.Change[]</parameterValue> <type> <name>Amazon.Route53.Model.Change[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ChangeBatch_Comment</name> <description> <para><i>Optional:</i> Any comments you want to include about a change batch request. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that contains the resource record sets that you want to change. </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.Route53.Model.ChangeInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ChangeInfo object. The service call response (type Amazon.Route53.Model.ChangeResourceRecordSetsResponse) 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=Edit-R53ResourceRecordSet.html&tocid=Edit-R53ResourceRecordSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> $change1 = New-Object Amazon.Route53.Model.Change PS C:\> $change1.Action = "CREATE" PS C:\> $change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change1.ResourceRecordSet.Name = "www.example.com" PS C:\> $change1.ResourceRecordSet.Type = "TXT" PS C:\> $change1.ResourceRecordSet.TTL = 600 PS C:\> $change1.ResourceRecordSet.ResourceRecords.Add(@{Value="item 1 item 2 item 3"}) PS C:\> $change2 = New-Object Amazon.Route53.Model.Change PS C:\> $change2.Action = "DELETE" PS C:\> $change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change2.ResourceRecordSet.Name = "test.example.com" PS C:\> $change2.ResourceRecordSet.Type = "A" PS C:\> $change2.ResourceRecordSet.TTL = 600 PS C:\> $change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.3"}) PS C:\> $change3 = New-Object Amazon.Route53.Model.Change PS C:\> $change3.Action = "CREATE" PS C:\> $change3.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change3.ResourceRecordSet.Name = "test.example.com" PS C:\> $change3.ResourceRecordSet.Type = "A" PS C:\> $change3.ResourceRecordSet.TTL = 600 PS C:\> $change3.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.1"}) PS C:\> $params = @{ HostedZoneId="Z1PA6795UKMFR9" ChangeBatch_Comment="This change batch creates a TXT record for www.example.com. and changes the A record for test.example.com. from 192.0.2.3 to 192.0.2.1." ChangeBatch_Change=$change1,$change2,$change3 } PS C:\> Edit-R53ResourceRecordSet @params </code><remarks><para>Description</para><para>-----------</para><para>This example creates an A record for www.example.com and changes the A record for test.example.com from 192.0.2.3 to 192.0.2.1. See the <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/api-change-resource-record-sets-example-basic.html">Amazon Route 53</a> documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> $change1 = New-Object Amazon.Route53.Model.Change PS C:\> $change1.Action = "CREATE" PS C:\> $change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change1.ResourceRecordSet.Name = "example.com" PS C:\> $change1.ResourceRecordSet.Type = "A" PS C:\> $change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget PS C:\> $change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111" PS C:\> $change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com." PS C:\> $change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true PS C:\> $change2 = New-Object Amazon.Route53.Model.Change PS C:\> $change2.Action = "CREATE" PS C:\> $change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change1.ResourceRecordSet.Name = "www.example.com" PS C:\> $change1.ResourceRecordSet.Type = "A" PS C:\> $change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget PS C:\> $change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111" PS C:\> $change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com." PS C:\> $change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false PS C:\> $params = @{ HostedZoneId="Z222222222" ChangeBatch_Comment="This change batch creates two alias resource record sets, one for the zone apex, example.com, and one for www.example.com, that both point to example-load-balancer-1111111111.us-east-1.elb.amazonaws.com." ChangeBatch_Change=$change1,$change2 } PS C:\> Edit-R53ResourceRecordSet @params </code><remarks><para>Description</para><para>-----------</para><para>This example shows how to create alias resource record sets. 'Z222222222' is the ID of the Amazon Route 53 hosted zone in which you're creating the alias resource record set. 'example.com' is the zone apex for which you want to create an alias and 'www.example.com' is a subdomain for which you also want to create an alias. 'Z1111111111111' is an example of a hosted zone ID for the load balancer and 'example-load-balancer-1111111111.us-east-1.elb.amazonaws.com' is an example of a load balancer domain name with which Amazon Route 53 responds to queries for example.com and www.example.com. See the <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/CreateAliasRRSAPI.html">Amazon Route 53</a> documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> PS C:\> $change1 = New-Object Amazon.Route53.Model.Change PS C:\> $change1.Action = "CREATE" PS C:\> $change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change1.ResourceRecordSet.Name = "www.example.com" PS C:\> $change1.ResourceRecordSet.Type = "A" PS C:\> $change1.ResourceRecordSet.SetIdentifier = "Rack 2, Positions 4 and 5" PS C:\> $change1.ResourceRecordSet.Weight = 1 PS C:\> $change1.ResourceRecordSet.TTL = 600 PS C:\> $change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.9"}) PS C:\> $change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.10"}) PS C:\> $change2 = New-Object Amazon.Route53.Model.Change PS C:\> $change2.Action = "CREATE" PS C:\> $change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change2.ResourceRecordSet.Name = "www.example.com" PS C:\> $change2.ResourceRecordSet.Type = "A" PS C:\> $change2.ResourceRecordSet.SetIdentifier = "Rack 5, Positions 1 and 2" PS C:\> $change2.ResourceRecordSet.Weight = 3 PS C:\> $change2.ResourceRecordSet.TTL = 600 PS C:\> $change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.11"}) PS C:\> $change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.12"}) PS C:\> $params = @{ HostedZoneId="Z1PA6795UKMFR9" ChangeBatch_Comment="This change creates two weighted resource record sets, each of which has two values." ChangeBatch_Change=$change1,$change2 } PS C:\> Edit-R53ResourceRecordSet @params </code><remarks><para>Description</para><para>-----------</para><para>This example creates two A records for www.example.com. One-fourth of the time (1/(1+3)), Amazon Route 53 responds to queries for www.example.com with the two values for the first resource record set (192.0.2.9 and 192.0.2.10). Three-fourths of the time (3/(1+3)) Amazon Route 53 responds to queries for www.example.com with the two values for the second resource record set (192.0.2.11 and 192.0.2.12). See the <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets_Examples.html">Amazon Route 53</a> documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code> PS C:\> $change1 = New-Object Amazon.Route53.Model.Change PS C:\> $change1.Action = "CREATE" PS C:\> $change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change1.ResourceRecordSet.Name = "example.com" PS C:\> $change1.ResourceRecordSet.Type = "A" PS C:\> $change1.ResourceRecordSet.SetIdentifier = "1" PS C:\> $change1.ResourceRecordSet.Weight = 3 PS C:\> $change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget PS C:\> $change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111" PS C:\> $change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-east-1.elb.amazonaws.com." PS C:\> $change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true PS C:\> $change2 = New-Object Amazon.Route53.Model.Change PS C:\> $change2.Action = "CREATE" PS C:\> $change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change2.ResourceRecordSet.Name = "example.com" PS C:\> $change2.ResourceRecordSet.Type = "A" PS C:\> $change2.ResourceRecordSet.SetIdentifier = "2" PS C:\> $change2.ResourceRecordSet.Weight = 1 PS C:\> $change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget PS C:\> $change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z3333333333333" PS C:\> $change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-4444444444.us-east-1.elb.amazonaws.com." PS C:\> $change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false PS C:\> $params = @{ HostedZoneId="Z5555555555" ChangeBatch_Comment="This change batch creates two weighted alias resource record sets. Amazon Route 53 responds to queries for example.com with the first ELB domain 3/4ths of the times and the second one 1/4th of the time." ChangeBatch_Change=$change1,$change2 } PS C:\> Edit-R53ResourceRecordSet @params </code><remarks><para>Description</para><para>-----------</para><para>This example shows how to create weighted alias resource record sets assuming that example.com is the domain for which you want to create weighted alias resource record sets. SetIdentifier differentiates the two weighted alias resource record sets from one another. This element is required because the Name and Type elements have the same values for both resource record sets. Z1111111111111 and Z3333333333333 are examples of hosted zone IDs for the ELB load balancer specified by the value of DNSName. example-load-balancer-2222222222.us-east-1.elb.amazonaws.com and example-load-balancer-4444444444.us-east-1.elb.amazonaws.com are examples of Elastic Load Balancing domains from which Amazon Route 53 responds to queries for example.com. See the <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/CreateWeightedAliasRRSAPI.html">Amazon Route 53</a> documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code> PS C:\> $change1 = New-Object Amazon.Route53.Model.Change PS C:\> $change1.Action = "CREATE" PS C:\> $change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change1.ResourceRecordSet.Name = "example.com" PS C:\> $change1.ResourceRecordSet.Type = "A" PS C:\> $change1.ResourceRecordSet.SetIdentifier = "Oregon load balancer 1" PS C:\> $change1.ResourceRecordSet.Region = us-west-2 PS C:\> $change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget PS C:\> $change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111" PS C:\> $change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-west-2.elb.amazonaws.com" PS C:\> $change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true PS C:\> $change2 = New-Object Amazon.Route53.Model.Change PS C:\> $change2.Action = "CREATE" PS C:\> $change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet PS C:\> $change2.ResourceRecordSet.Name = "example.com" PS C:\> $change2.ResourceRecordSet.Type = "A" PS C:\> $change2.ResourceRecordSet.SetIdentifier = "Singapore load balancer 1" PS C:\> $change2.ResourceRecordSet.Region = ap-southeast-1 PS C:\> $change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget PS C:\> $change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z2222222222222" PS C:\> $change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.ap-southeast-1.elb.amazonaws.com" PS C:\> $change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true PS C:\> $params = @{ HostedZoneId="Z5555555555" ChangeBatch_Comment="This change batch creates two latency resource record sets, one for the US West (Oregon) region and one for the Asia Pacific (Singapore) region." ChangeBatch_Change=$change1,$change2 } PS C:\> Edit-R53ResourceRecordSet @params </code><remarks><para>Description</para><para>-----------</para><para>This example creates two latency alias resource record sets, one for an ELB load balancer in the US West (Oregon) region (us-west-2), and another for a load balancer in the Asia Pacific (Singapore) region (ap-southeast-1). See the <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/CreateLatencyRRSAPI.html">Amazon Route 53</a> documentation for more details. You can use the Get-R53Change cmdlet to poll to determine when the changes are complete.</para><para /><para /></remarks> </example> </examples> </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>Edit-R53TagsForResource</name> <description> <para>Invokes the ChangeTagsForResource operation against Amazon Route 53.</para> </description> <verb>Edit</verb> <noun>R53TagsForResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Edit-R53TagsForResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource for which you want to add, change, or delete tags. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AddTag</name> <description> <para>A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit <code>Value</code> for. You can add a maximum of 10 tags to a health check or a hosted zone. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RemoveTagKey</name> <description> <para>A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the resource. - The resource type for health checks is <code>healthcheck</code>. - The resource type for hosted zones is <code>hostedzone</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.TagResourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AddTag</name> <description> <para>A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit <code>Value</code> for. You can add a maximum of 10 tags to a health check or a hosted zone. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.Model.Tag[]</parameterValue> <type> <name>Amazon.Route53.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>RemoveTagKey</name> <description> <para>A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys. </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 (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource for which you want to add, change, or delete tags. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the resource. - The resource type for health checks is <code>healthcheck</code>. - The resource type for hosted zones is <code>hostedzone</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.TagResourceType</parameterValue> <type> <name>Amazon.Route53.TagResourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53.Model.ChangeTagsForResourceResponse) 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=Edit-R53TagsForResource.html&tocid=Edit-R53TagsForResource</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53Change</name> <description> <para>Invokes the GetChange operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53Change</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the current status of a change batch request. The status is one of the following values: - <code>PENDING</code> indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests. - <code>INSYNC</code> indicates that the changes have propagated to all Amazon Route 53 DNS servers. </para> </description> <syntax> <syntaxItem> <name>Get-R53Change</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the change batch request. The value that you specify here is the value that <code>ChangeResourceRecordSets</code> returned in the <code>Id</code> element when you submitted the request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the change batch request. The value that you specify here is the value that <code>ChangeResourceRecordSets</code> returned in the <code>Id</code> element when you submitted the request. </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.Route53.Model.ChangeInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ChangeInfo object. The service call response (type Amazon.Route53.Model.GetChangeResponse) 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-R53Change.html&tocid=Get-R53Change</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53CheckerIpRange</name> <description> <para>Invokes the GetCheckerIpRanges operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53CheckerIpRange</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para><code>GetCheckerIpRanges</code> still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/route-53-ip-addresses.html">IP Address Ranges of Amazon Route 53 Servers</a> in the <i>Amazon Route 53 Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-R53CheckerIpRange</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.Route53.Model.GetCheckerIpRangesResponse) 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-R53CheckerIpRange.html&tocid=Get-R53CheckerIpRange</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53GeoLocation</name> <description> <para>Invokes the GetGeoLocation operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53GeoLocation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets. Use the following syntax to determine whether a continent is supported for geolocation: <code>GET /2013-04-01/geolocation?ContinentCode=<i>two-letter abbreviation for a continent</i></code> Use the following syntax to determine whether a country is supported for geolocation: <code>GET /2013-04-01/geolocation?CountryCode=<i>two-character country code</i></code> Use the following syntax to determine whether a subdivision of a country is supported for geolocation: <code>GET /2013-04-01/geolocation?CountryCode=<i>two-character country code</i>&amp;SubdivisionCode=<i>subdivision code</i></code> </para> </description> <syntax> <syntaxItem> <name>Get-R53GeoLocation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContinentCode</name> <description> <para>Amazon Route 53 supports the following continent codes: - <b>AF</b>: Africa - <b>AN</b>: Antarctica - <b>AS</b>: Asia - <b>EU</b>: Europe - <b>OC</b>: Oceania - <b>NA</b>: North America - <b>SA</b>: South America </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CountryCode</name> <description> <para>Amazon Route 53 uses the two-letter country codes that are specified in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO standard 3166-1 alpha-2</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SubdivisionCode</name> <description> <para>Amazon Route 53 uses the one- to three-letter subdivision codes that are specified in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO standard 3166-1 alpha-2</a>. Amazon Route 53 doesn't support subdivision codes for all countries. If you specify <code>SubdivisionCode</code>, you must also specify <code>CountryCode</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ContinentCode</name> <description> <para>Amazon Route 53 supports the following continent codes: - <b>AF</b>: Africa - <b>AN</b>: Antarctica - <b>AS</b>: Asia - <b>EU</b>: Europe - <b>OC</b>: Oceania - <b>NA</b>: North America - <b>SA</b>: South America </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="False" position="Named"> <name>CountryCode</name> <description> <para>Amazon Route 53 uses the two-letter country codes that are specified in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO standard 3166-1 alpha-2</a>. </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="False" position="Named"> <name>SubdivisionCode</name> <description> <para>Amazon Route 53 uses the one- to three-letter subdivision codes that are specified in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO standard 3166-1 alpha-2</a>. Amazon Route 53 doesn't support subdivision codes for all countries. If you specify <code>SubdivisionCode</code>, you must also specify <code>CountryCode</code>. </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.Route53.Model.GeoLocationDetails</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a GeoLocationDetails object. The service call response (type Amazon.Route53.Model.GetGeoLocationResponse) 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-R53GeoLocation.html&tocid=Get-R53GeoLocation</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53GeoLocationList</name> <description> <para>Invokes the ListGeoLocations operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53GeoLocationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a list of supported geo locations. Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country. </para> </description> <syntax> <syntaxItem> <name>Get-R53GeoLocationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartContinentCode</name> <description> <para>The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if <code>IsTruncated</code> is true, and if <code>NextContinentCode</code> from the previous response has a value, enter that value in <code>StartContinentCode</code> to return the next page of results. Include <code>StartContinentCode</code> only if you want to list continents. Don't include <code>StartContinentCode</code> when you're listing countries or countries with their subdivisions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartCountryCode</name> <description> <para>The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if <code>IsTruncated</code> is <code>true</code>, and if <code>NextCountryCode</code> from the previous response has a value, enter that value in <code>StartCountryCode</code> to return the next page of results. Amazon Route 53 uses the two-letter country codes that are specified in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO standard 3166-1 alpha-2</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartSubdivisionCode</name> <description> <para>The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if <code>IsTruncated</code> is <code>true</code>, and if <code>NextSubdivisionCode</code> from the previous response has a value, enter that value in <code>StartSubdivisionCode</code> to return the next page of results. To list subdivisions of a country, you must include both <code>StartCountryCode</code> and <code>StartSubdivisionCode</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>(Optional) The maximum number of geolocations to be included in the response body for this request. If more than <code>MaxItems</code> geolocations remain to be listed, then the value of the <code>IsTruncated</code> element in the response is <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>(Optional) The maximum number of geolocations to be included in the response body for this request. If more than <code>MaxItems</code> geolocations remain to be listed, then the value of the <code>IsTruncated</code> element in the response is <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartContinentCode</name> <description> <para>The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if <code>IsTruncated</code> is true, and if <code>NextContinentCode</code> from the previous response has a value, enter that value in <code>StartContinentCode</code> to return the next page of results. Include <code>StartContinentCode</code> only if you want to list continents. Don't include <code>StartContinentCode</code> when you're listing countries or countries with their subdivisions. </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="False" position="Named"> <name>StartCountryCode</name> <description> <para>The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if <code>IsTruncated</code> is <code>true</code>, and if <code>NextCountryCode</code> from the previous response has a value, enter that value in <code>StartCountryCode</code> to return the next page of results. Amazon Route 53 uses the two-letter country codes that are specified in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO standard 3166-1 alpha-2</a>. </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="False" position="Named"> <name>StartSubdivisionCode</name> <description> <para>The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if <code>IsTruncated</code> is <code>true</code>, and if <code>NextSubdivisionCode</code> from the previous response has a value, enter that value in <code>StartSubdivisionCode</code> to return the next page of results. To list subdivisions of a country, you must include both <code>StartCountryCode</code> and <code>StartSubdivisionCode</code>. </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.Route53.Model.ListGeoLocationsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.ListGeoLocationsResponse 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-R53GeoLocationList.html&tocid=Get-R53GeoLocationList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53HealthCheck</name> <description> <para>Invokes the GetHealthCheck operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53HealthCheck</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about a specified health check. </para> </description> <syntax> <syntaxItem> <name>Get-R53HealthCheck</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. </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.Route53.Model.HealthCheck</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a HealthCheck object. The service call response (type Amazon.Route53.Model.GetHealthCheckResponse) 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-R53HealthCheck.html&tocid=Get-R53HealthCheck</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53HealthCheckCount</name> <description> <para>Invokes the GetHealthCheckCount operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53HealthCheckCount</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the number of health checks that are associated with the current AWS account. </para> </description> <syntax> <syntaxItem> <name>Get-R53HealthCheckCount</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>System.Int64</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Int64 object. The service call response (type Amazon.Route53.Model.GetHealthCheckCountResponse) 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-R53HealthCheckCount.html&tocid=Get-R53HealthCheckCount</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53HealthCheckLastFailureReason</name> <description> <para>Invokes the GetHealthCheckLastFailureReason operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53HealthCheckLastFailureReason</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets the reason that a specified health check failed most recently. </para> </description> <syntax> <syntaxItem> <name>Get-R53HealthCheckLastFailureReason</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The ID for the health check for which you want the last failure reason. When you created the health check, <code>CreateHealthCheck</code> returned the ID in the response, in the <code>HealthCheckId</code> element. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The ID for the health check for which you want the last failure reason. When you created the health check, <code>CreateHealthCheck</code> returned the ID in the response, in the <code>HealthCheckId</code> element. </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.Route53.Model.HealthCheckObservation</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HealthCheckObservation objects. The service call response (type Amazon.Route53.Model.GetHealthCheckLastFailureReasonResponse) 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-R53HealthCheckLastFailureReason.html&tocid=Get-R53HealthCheckLastFailureReason</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53HealthCheckList</name> <description> <para>Invokes the ListHealthChecks operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53HealthCheckList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieve a list of the health checks that are associated with the current AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-R53HealthCheckList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more health checks. To get another group, submit another <code>ListHealthChecks</code> request. For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more health checks to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of health checks that you want <code>ListHealthChecks</code> to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set <code>MaxItems</code> to a value greater than 100, Amazon Route 53 returns only the first 100 health checks. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more health checks. To get another group, submit another <code>ListHealthChecks</code> request. For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more health checks to get. </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="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of health checks that you want <code>ListHealthChecks</code> to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set <code>MaxItems</code> to a value greater than 100, Amazon Route 53 returns only the first 100 health checks. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.HealthCheck</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HealthCheck objects. The service call response (type Amazon.Route53.Model.ListHealthChecksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String), IsTruncated (type System.Boolean), NextMarker (type System.String), MaxItems (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53HealthCheckList.html&tocid=Get-R53HealthCheckList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53HealthCheckStatus</name> <description> <para>Invokes the GetHealthCheckStatus operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53HealthCheckStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets status of a specified health check. </para> </description> <syntax> <syntaxItem> <name>Get-R53HealthCheckStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The ID for the health check that you want the current status for. When you created the health check, <code>CreateHealthCheck</code> returned the ID in the response, in the <code>HealthCheckId</code> element. If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use <code>GetHealthCheckStatus</code> to get the status of a calculated health check. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The ID for the health check that you want the current status for. When you created the health check, <code>CreateHealthCheck</code> returned the ID in the response, in the <code>HealthCheckId</code> element. If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use <code>GetHealthCheckStatus</code> to get the status of a calculated health check. </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.Route53.Model.HealthCheckObservation</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HealthCheckObservation objects. The service call response (type Amazon.Route53.Model.GetHealthCheckStatusResponse) 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-R53HealthCheckStatus.html&tocid=Get-R53HealthCheckStatus</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53HostedZone</name> <description> <para>Invokes the GetHostedZone operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53HostedZone</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about a specified hosted zone including the four name servers assigned to the hosted zone. </para> </description> <syntax> <syntaxItem> <name>Get-R53HostedZone</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the hosted zone that you want to get information about. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the hosted zone that you want to get information about. </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.Route53.Model.GetHostedZoneResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.GetHostedZoneResponse 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-R53HostedZone.html&tocid=Get-R53HostedZone</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-R53HostedZone -Id Z1D633PJN98FT9</code><remarks><para>Description</para><para>-----------</para><para>Returns details of the hosted zone with ID Z1D633PJN98FT9.</para><para /><para /></remarks> </example> </examples> </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>Get-R53HostedZoneCount</name> <description> <para>Invokes the GetHostedZoneCount operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53HostedZoneCount</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the number of hosted zones that are associated with the current AWS account. </para> </description> <syntax> <syntaxItem> <name>Get-R53HostedZoneCount</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>System.Int64</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Int64 object. The service call response (type Amazon.Route53.Model.GetHostedZoneCountResponse) 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-R53HostedZoneCount.html&tocid=Get-R53HostedZoneCount</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-R53HostedZoneCount</code><remarks><para>Description</para><para>-----------</para><para>Returns the total number of public and private hosted zones for the current AWS account.</para><para /><para /></remarks> </example> </examples> </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>Get-R53HostedZoneList</name> <description> <para>Invokes the ListHostedZones operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53HostedZoneList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a <code>HostedZones</code> child element for each hosted zone. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the <code>maxitems</code> parameter to list them in groups of up to 100. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-R53HostedZoneList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DelegationSetId</name> <description> <para>If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more hosted zones. To get more hosted zones, submit another <code>ListHostedZones</code> request. For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more hosted zones to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than <code>maxitems</code> hosted zones, the value of <code>IsTruncated</code> in the response is <code>true</code>, and the value of <code>NextMarker</code> is the hosted zone ID of the first hosted zone that Amazon Route 53 will return if you submit another request. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DelegationSetId</name> <description> <para>If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set. </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="False" position="Named"> <name>Marker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more hosted zones. To get more hosted zones, submit another <code>ListHostedZones</code> request. For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more hosted zones to get. </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="False" position="Named"> <name>MaxItem</name> <description> <para>(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than <code>maxitems</code> hosted zones, the value of <code>IsTruncated</code> in the response is <code>true</code>, and the value of <code>NextMarker</code> is the hosted zone ID of the first hosted zone that Amazon Route 53 will return if you submit another request. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.HostedZone</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HostedZone objects. The service call response (type Amazon.Route53.Model.ListHostedZonesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String), IsTruncated (type System.Boolean), NextMarker (type System.String), MaxItems (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53HostedZoneList.html&tocid=Get-R53HostedZoneList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-R53HostedZoneList</code><remarks><para>Description</para><para>-----------</para><para>Outputs all of your public and private hosted zones.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-R53HostedZoneList -DelegationSetId NZ8X2CISAMPLE</code><remarks><para>Description</para><para>-----------</para><para>Outputs all of the hosted zones that are associated with the reusable delegation set that has the ID NZ8X2CISAMPLE</para><para /><para /></remarks> </example> </examples> </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>Get-R53QueryLoggingConfig</name> <description> <para>Invokes the GetQueryLoggingConfig operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53QueryLoggingConfig</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about a specified configuration for DNS query logging. For more information about DNS query logs, see <a>CreateQueryLoggingConfig</a> and <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html">Logging DNS Queries</a>. </para> </description> <syntax> <syntaxItem> <name>Get-R53QueryLoggingConfig</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the configuration for DNS query logging that you want to get information about. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the configuration for DNS query logging that you want to get information about. </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.Route53.Model.QueryLoggingConfig</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a QueryLoggingConfig object. The service call response (type Amazon.Route53.Model.GetQueryLoggingConfigResponse) 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-R53QueryLoggingConfig.html&tocid=Get-R53QueryLoggingConfig</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53QueryLoggingConfigList</name> <description> <para>Invokes the ListQueryLoggingConfigs operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53QueryLoggingConfigList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone. For more information about DNS query logs, see <a>CreateQueryLoggingConfig</a>. Additional information, including the format of DNS query logs, appears in <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html">Logging DNS Queries</a> in the <i>Amazon Route 53 Developer Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-R53QueryLoggingConfigList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in <code>HostedZoneId</code>. If you don't specify a hosted zone ID, <code>ListQueryLoggingConfigs</code> returns all of the configurations that are associated with the current AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current AWS account has more than <code>MaxResults</code> configurations, use the value of <a>ListQueryLoggingConfigsResponse$NextToken</a> in the response to get the next page of results. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 100 configurations. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>(Optional) If the current AWS account has more than <code>MaxResults</code> query logging configurations, use <code>NextToken</code> to get the second and subsequent pages of results. For the first <code>ListQueryLoggingConfigs</code> request, omit this value. For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in <code>HostedZoneId</code>. If you don't specify a hosted zone ID, <code>ListQueryLoggingConfigs</code> returns all of the configurations that are associated with the current AWS account. </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="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current AWS account has more than <code>MaxResults</code> configurations, use the value of <a>ListQueryLoggingConfigsResponse$NextToken</a> in the response to get the next page of results. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 100 configurations. </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="False" position="Named"> <name>NextToken</name> <description> <para>(Optional) If the current AWS account has more than <code>MaxResults</code> query logging configurations, use <code>NextToken</code> to get the second and subsequent pages of results. For the first <code>ListQueryLoggingConfigs</code> request, omit this value. For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request. </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.Route53.Model.QueryLoggingConfig</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of QueryLoggingConfig objects. The service call response (type Amazon.Route53.Model.ListQueryLoggingConfigsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53QueryLoggingConfigList.html&tocid=Get-R53QueryLoggingConfigList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53ResourceRecordSet</name> <description> <para>Invokes the ListResourceRecordSets operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53ResourceRecordSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the resource record sets in a specified hosted zone. <code>ListResourceRecordSets</code> returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the <code>name</code> and <code>type</code> elements. The action sorts results first by DNS name with the labels reversed, for example: <code>com.example.www.</code> Note the trailing dot, which can change the sort order in some circumstances. When multiple records have the same DNS name, the action sorts results by the record type. You can use the name and type elements to adjust the beginning position of the list of resource record sets returned: If you do not specify Name or Type The results begin with the first resource record set that the hosted zone contains. If you specify Name but not Type The results begin with the first resource record set in the list whose name is greater than or equal to <code>Name</code>. If you specify Type but not Name Amazon Route 53 returns the <code>InvalidInput</code> error. If you specify both Name and Type The results begin with the first resource record set in the list whose name is greater than or equal to <code>Name</code>, and whose type is greater than or equal to <code>Type</code>. This action returns the most current version of the records. This includes records that are <code>PENDING</code>, and that are not yet available on all Amazon Route 53 DNS servers. To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a <code>ChangeResourceRecordSets</code> request while you're paging through the results of a <code>ListResourceRecordSets</code> request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes. </para> </description> <syntax> <syntaxItem> <name>Get-R53ResourceRecordSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that contains the resource record sets that you want to list. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>StartRecordName</name> <description> <para>The first name in the lexicographic ordering of resource record sets that you want to list. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>StartRecordType</name> <description> <para>The type of resource record set to begin the record listing from. Valid values for basic resource record sets: <code>A</code> | <code>AAAA</code> | <code>CAA</code> | <code>CNAME</code> | <code>MX</code> | <code>NAPTR</code> | <code>NS</code> | <code>PTR</code> | <code>SOA</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code> Values for weighted, latency, geo, and failover resource record sets: <code>A</code> | <code>AAAA</code> | <code>CAA</code> | <code>CNAME</code> | <code>MX</code> | <code>NAPTR</code> | <code>PTR</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code> Values for alias resource record sets: - <b>CloudFront distribution</b>: A or AAAA - <b>Elastic Beanstalk environment that has a regionalized subdomain</b>: A - <b>ELB load balancer</b>: A | AAAA - <b>Amazon S3 bucket</b>: A - <b>Another resource record set in this hosted zone:</b> The type of the resource record set that the alias references. Constraint: Specifying <code>type</code> without specifying <code>name</code> returns an <code>InvalidInput</code> error. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartRecordIdentifier</name> <description> <para><i>Weighted resource record sets only:</i> If results were truncated for a given DNS name and type, specify the value of <code>NextRecordIdentifier</code> from the previous response to get the next resource record set that has the current DNS name and type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than <code>maxitems</code> resource record sets, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of the <code>NextRecordName</code> and <code>NextRecordType</code> elements in the response identify the first resource record set in the next group of <code>maxitems</code> resource record sets. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that contains the resource record sets that you want to list. </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="False" position="Named"> <name>MaxItem</name> <description> <para>(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than <code>maxitems</code> resource record sets, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of the <code>NextRecordName</code> and <code>NextRecordType</code> elements in the response identify the first resource record set in the next group of <code>maxitems</code> resource record sets. </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="False" position="Named"> <name>StartRecordIdentifier</name> <description> <para><i>Weighted resource record sets only:</i> If results were truncated for a given DNS name and type, specify the value of <code>NextRecordIdentifier</code> from the previous response to get the next resource record set that has the current DNS name and type. </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="False" position="2"> <name>StartRecordName</name> <description> <para>The first name in the lexicographic ordering of resource record sets that you want to list. </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="False" position="3"> <name>StartRecordType</name> <description> <para>The type of resource record set to begin the record listing from. Valid values for basic resource record sets: <code>A</code> | <code>AAAA</code> | <code>CAA</code> | <code>CNAME</code> | <code>MX</code> | <code>NAPTR</code> | <code>NS</code> | <code>PTR</code> | <code>SOA</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code> Values for weighted, latency, geo, and failover resource record sets: <code>A</code> | <code>AAAA</code> | <code>CAA</code> | <code>CNAME</code> | <code>MX</code> | <code>NAPTR</code> | <code>PTR</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code> Values for alias resource record sets: - <b>CloudFront distribution</b>: A or AAAA - <b>Elastic Beanstalk environment that has a regionalized subdomain</b>: A - <b>ELB load balancer</b>: A | AAAA - <b>Amazon S3 bucket</b>: A - <b>Another resource record set in this hosted zone:</b> The type of the resource record set that the alias references. Constraint: Specifying <code>type</code> without specifying <code>name</code> returns an <code>InvalidInput</code> error. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> <type> <name>Amazon.Route53.RRType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.ListResourceRecordSetsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.ListResourceRecordSetsResponse 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-R53ResourceRecordSet.html&tocid=Get-R53ResourceRecordSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53ReusableDelegationSet</name> <description> <para>Invokes the GetReusableDelegationSet operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53ReusableDelegationSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set. </para> </description> <syntax> <syntaxItem> <name>Get-R53ReusableDelegationSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the reusable delegation set that you want to get a list of name servers for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the reusable delegation set that you want to get a list of name servers for. </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.Route53.Model.DelegationSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DelegationSet object. The service call response (type Amazon.Route53.Model.GetReusableDelegationSetResponse) 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-R53ReusableDelegationSet.html&tocid=Get-R53ReusableDelegationSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53ReusableDelegationSetList</name> <description> <para>Invokes the ListReusableDelegationSets operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53ReusableDelegationSetList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a list of the reusable delegation sets that are associated with the current AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-R53ReusableDelegationSetList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more reusable delegation sets. To get another group, submit another <code>ListReusableDelegationSets</code> request. For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more reusable delegation sets to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Amazon Route 53 returns only the first 100 reusable delegation sets. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more reusable delegation sets. To get another group, submit another <code>ListReusableDelegationSets</code> request. For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more reusable delegation sets to get. </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="False" position="Named"> <name>MaxItem</name> <description> <para>The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Amazon Route 53 returns only the first 100 reusable delegation sets. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.DelegationSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DelegationSet objects. The service call response (type Amazon.Route53.Model.ListReusableDelegationSetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String), IsTruncated (type System.Boolean), NextMarker (type System.String), MaxItems (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53ReusableDelegationSetList.html&tocid=Get-R53ReusableDelegationSetList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TagsForResource</name> <description> <para>Invokes the ListTagsForResource operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TagsForResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists tags for one health check or hosted zone. For information about using tags for cost allocation, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-R53TagsForResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource for which you want to retrieve tags. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the resource. - The resource type for health checks is <code>healthcheck</code>. - The resource type for hosted zones is <code>hostedzone</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.TagResourceType</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the resource for which you want to retrieve tags. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the resource. - The resource type for health checks is <code>healthcheck</code>. - The resource type for hosted zones is <code>hostedzone</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.TagResourceType</parameterValue> <type> <name>Amazon.Route53.TagResourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.ResourceTagSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ResourceTagSet object. The service call response (type Amazon.Route53.Model.ListTagsForResourceResponse) 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-R53TagsForResource.html&tocid=Get-R53TagsForResource</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TagsForResourceList</name> <description> <para>Invokes the ListTagsForResources operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TagsForResourceList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists tags for up to 10 health checks or hosted zones. For information about using tags for cost allocation, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-R53TagsForResourceList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceId</name> <description> <para>A complex type that contains the ResourceId element for each resource for which you want to get a list of tags. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the resources. - The resource type for health checks is <code>healthcheck</code>. - The resource type for hosted zones is <code>hostedzone</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.TagResourceType</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceId</name> <description> <para>A complex type that contains the ResourceId element for each resource for which you want to get a list of tags. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the resources. - The resource type for health checks is <code>healthcheck</code>. - The resource type for hosted zones is <code>hostedzone</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.TagResourceType</parameterValue> <type> <name>Amazon.Route53.TagResourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.ResourceTagSet</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ResourceTagSet objects. The service call response (type Amazon.Route53.Model.ListTagsForResourcesResponse) 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-R53TagsForResourceList.html&tocid=Get-R53TagsForResourceList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TrafficPolicy</name> <description> <para>Invokes the GetTrafficPolicy operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TrafficPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about a specific traffic policy version. </para> </description> <syntax> <syntaxItem> <name>Get-R53TrafficPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy that you want to get information about. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>The version number of the traffic policy that you want to get information about. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy that you want to get information about. </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="False" position="Named"> <name>Version</name> <description> <para>The version number of the traffic policy that you want to get information about. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.TrafficPolicy</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TrafficPolicy object. The service call response (type Amazon.Route53.Model.GetTrafficPolicyResponse) 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-R53TrafficPolicy.html&tocid=Get-R53TrafficPolicy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TrafficPolicyInstance</name> <description> <para>Invokes the GetTrafficPolicyInstance operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TrafficPolicyInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about a specified traffic policy instance. After you submit a <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTrafficPolicyInstance</code> request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the <code>State</code> response element. In the Amazon Route 53 console, traffic policy instances are known as policy records. </para> </description> <syntax> <syntaxItem> <name>Get-R53TrafficPolicyInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy instance that you want to get information about. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy instance that you want to get information about. </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.Route53.Model.TrafficPolicyInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TrafficPolicyInstance object. The service call response (type Amazon.Route53.Model.GetTrafficPolicyInstanceResponse) 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-R53TrafficPolicyInstance.html&tocid=Get-R53TrafficPolicyInstance</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TrafficPolicyInstanceCount</name> <description> <para>Invokes the GetTrafficPolicyInstanceCount operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TrafficPolicyInstanceCount</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets the number of traffic policy instances that are associated with the current AWS account. </para> </description> <syntax> <syntaxItem> <name>Get-R53TrafficPolicyInstanceCount</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>System.Int32</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Int32 object. The service call response (type Amazon.Route53.Model.GetTrafficPolicyInstanceCountResponse) 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-R53TrafficPolicyInstanceCount.html&tocid=Get-R53TrafficPolicyInstanceCount</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TrafficPolicyInstanceList</name> <description> <para>Invokes the ListTrafficPolicyInstances operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TrafficPolicyInstanceList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about the traffic policy instances that you created by using the current AWS account. After you submit an <code>UpdateTrafficPolicyInstance</code> request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the <code>State</code> response element. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the <code>MaxItems</code> parameter to list them in groups of up to 100. </para> </description> <syntax> <syntaxItem> <name>Get-R53TrafficPolicyInstanceList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostedZoneIdMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>HostedZoneId</code>, specify the value of <code>HostedZoneIdMarker</code> from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyInstanceNameMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancename</code>, specify the value of <code>TrafficPolicyInstanceNameMarker</code> from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyInstanceTypeMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancetype</code>, specify the value of <code>TrafficPolicyInstanceTypeMarker</code> from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a <code>ListTrafficPolicyInstances</code> request. If you have more than <code>MaxItems</code> traffic policy instances, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy instance in the next group of <code>MaxItems</code> traffic policy instances. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostedZoneIdMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>HostedZoneId</code>, specify the value of <code>HostedZoneIdMarker</code> from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </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="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a <code>ListTrafficPolicyInstances</code> request. If you have more than <code>MaxItems</code> traffic policy instances, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy instance in the next group of <code>MaxItems</code> traffic policy instances. </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="False" position="Named"> <name>TrafficPolicyInstanceNameMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancename</code>, specify the value of <code>TrafficPolicyInstanceNameMarker</code> from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </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="False" position="Named"> <name>TrafficPolicyInstanceTypeMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancetype</code>, specify the value of <code>TrafficPolicyInstanceTypeMarker</code> from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> <type> <name>Amazon.Route53.RRType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.ListTrafficPolicyInstancesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.ListTrafficPolicyInstancesResponse 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-R53TrafficPolicyInstanceList.html&tocid=Get-R53TrafficPolicyInstanceList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TrafficPolicyInstancesByHostedZone</name> <description> <para>Invokes the ListTrafficPolicyInstancesByHostedZone operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TrafficPolicyInstancesByHostedZone</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about the traffic policy instances that you created in a specified hosted zone. After you submit a <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTrafficPolicyInstance</code> request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the <code>State</code> response element. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the <code>MaxItems</code> parameter to list them in groups of up to 100. </para> </description> <syntax> <syntaxItem> <name>Get-R53TrafficPolicyInstancesByHostedZone</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that you want to list traffic policy instances for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyInstanceNameMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancename</code>, specify the value of <code>TrafficPolicyInstanceNameMarker</code> from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyInstanceTypeMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancetype</code>, specify the value of <code>TrafficPolicyInstanceTypeMarker</code> from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policy instances to be included in the response body for this request. If you have more than <code>MaxItems</code> traffic policy instances, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy instance that Amazon Route 53 will return if you submit another request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that you want to list traffic policy instances for. </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="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policy instances to be included in the response body for this request. If you have more than <code>MaxItems</code> traffic policy instances, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy instance that Amazon Route 53 will return if you submit another request. </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="False" position="Named"> <name>TrafficPolicyInstanceNameMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancename</code>, specify the value of <code>TrafficPolicyInstanceNameMarker</code> from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </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="False" position="Named"> <name>TrafficPolicyInstanceTypeMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancetype</code>, specify the value of <code>TrafficPolicyInstanceTypeMarker</code> from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> <type> <name>Amazon.Route53.RRType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneResponse 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-R53TrafficPolicyInstancesByHostedZone.html&tocid=Get-R53TrafficPolicyInstancesByHostedZone</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53TrafficPolicyInstancesByPolicy</name> <description> <para>Invokes the ListTrafficPolicyInstancesByPolicy operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53TrafficPolicyInstancesByPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about the traffic policy instances that you created by using a specify traffic policy version. After you submit a <code>CreateTrafficPolicyInstance</code> or an <code>UpdateTrafficPolicyInstance</code> request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the <code>State</code> response element. Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the <code>MaxItems</code> parameter to list them in groups of up to 100. </para> </description> <syntax> <syntaxItem> <name>Get-R53TrafficPolicyInstancesByPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TrafficPolicyId</name> <description> <para>The ID of the traffic policy for which you want to list traffic policy instances. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostedZoneIdMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request. For the value of <code>hostedzoneid</code>, specify the value of <code>HostedZoneIdMarker</code> from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyInstanceNameMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request. For the value of <code>trafficpolicyinstancename</code>, specify the value of <code>TrafficPolicyInstanceNameMarker</code> from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyInstanceTypeMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request. For the value of <code>trafficpolicyinstancetype</code>, specify the value of <code>TrafficPolicyInstanceTypeMarker</code> from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyVersion</name> <description> <para>The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by <code>TrafficPolicyId</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policy instances to be included in the response body for this request. If you have more than <code>MaxItems</code> traffic policy instances, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy instance that Amazon Route 53 will return if you submit another request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostedZoneIdMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request. For the value of <code>hostedzoneid</code>, specify the value of <code>HostedZoneIdMarker</code> from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </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="False" position="Named"> <name>MaxItem</name> <description> <para>The maximum number of traffic policy instances to be included in the response body for this request. If you have more than <code>MaxItems</code> traffic policy instances, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy instance that Amazon Route 53 will return if you submit another request. </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 (ByValue, )" position="1"> <name>TrafficPolicyId</name> <description> <para>The ID of the traffic policy for which you want to list traffic policy instances. </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="False" position="Named"> <name>TrafficPolicyInstanceNameMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request. For the value of <code>trafficpolicyinstancename</code>, specify the value of <code>TrafficPolicyInstanceNameMarker</code> from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </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="False" position="Named"> <name>TrafficPolicyInstanceTypeMarker</name> <description> <para>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstancesByPolicy</code> request. For the value of <code>trafficpolicyinstancetype</code>, specify the value of <code>TrafficPolicyInstanceTypeMarker</code> from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request. If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> <type> <name>Amazon.Route53.RRType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyVersion</name> <description> <para>The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by <code>TrafficPolicyId</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyResponse 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-R53TrafficPolicyInstancesByPolicy.html&tocid=Get-R53TrafficPolicyInstancesByPolicy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53VPCAssociationAuthorizationList</name> <description> <para>Invokes the ListVPCAssociationAuthorizations operation against Amazon Route 53.</para> </description> <verb>Get</verb> <noun>R53VPCAssociationAuthorizationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more <code>CreateVPCAssociationAuthorization</code> requests. The response includes a <code>VPCs</code> element with a <code>VPC</code> child element for each VPC that can be associated with the hosted zone. </para> </description> <syntax> <syntaxItem> <name>Get-R53VPCAssociationAuthorizationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para><i>Optional</i>: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 50 VPCs per page. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para><i>Optional</i>: If a response includes a <code>NextToken</code> element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of <code>NextToken</code> from the response in the <code>nexttoken</code> parameter in another <code>ListVPCAssociationAuthorizations</code> request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone. </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="False" position="Named"> <name>MaxResult</name> <description> <para><i>Optional</i>: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 50 VPCs per page. </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="False" position="Named"> <name>NextToken</name> <description> <para><i>Optional</i>: If a response includes a <code>NextToken</code> element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of <code>NextToken</code> from the response in the <code>nexttoken</code> parameter in another <code>ListVPCAssociationAuthorizations</code> request. </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.Route53.Model.ListVPCAssociationAuthorizationsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.ListVPCAssociationAuthorizationsResponse 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-R53VPCAssociationAuthorizationList.html&tocid=Get-R53VPCAssociationAuthorizationList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>New-R53HealthCheck</name> <description> <para>Invokes the CreateHealthCheck operation against Amazon Route 53.</para> </description> <verb>New</verb> <noun>R53HealthCheck</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new health check. For information about adding health checks to resource record sets, see <a>ResourceRecordSet$HealthCheckId</a> in <a>ChangeResourceRecordSets</a>. <b>ELB Load Balancers</b> If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to an Amazon Route 53 health check. <b>Private Hosted Zones</b> You can associate health checks with failover resource record sets in a private hosted zone. Note the following: - Amazon Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC. - You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server. - You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 <code>StatusCheckFailed</code> metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html">Amazon CloudWatch User Guide</a>. </para> </description> <syntax> <syntaxItem> <name>New-R53HealthCheck</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CallerReference</name> <description> <para>A unique string that identifies the request and that allows you to retry a failed <code>CreateHealthCheck</code> request without the risk of creating two identical health checks: - If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Amazon Route 53 returns the settings for the existing health check. - If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> as a deleted health check, regardless of the settings, Amazon Route 53 returns a <code>HealthCheckAlreadyExists</code> error. - If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> as an existing health check but with different settings, Amazon Route 53 returns a <code>HealthCheckAlreadyExists</code> error. - If you send a <code>CreateHealthCheck</code> request with a unique <code>CallerReference</code> but settings identical to an existing health check, Amazon Route 53 creates the health check. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_ChildHealthCheck</name> <description> <para>(CALCULATED Health Checks Only) A complex type that contains one <code>ChildHealthCheck</code> element for each health check that you want to associate with a <code>CALCULATED</code> health check. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_EnableSNI</name> <description> <para>Specify whether you want Amazon Route 53 to send the value of <code>FullyQualifiedDomainName</code> to the endpoint in the <code>client_hello</code> message during TLS negotiation. This allows the endpoint to respond to <code>HTTPS</code> health check requests with the applicable SSL/TLS certificate. Some endpoints require that <code>HTTPS</code> requests include the host name in the <code>client_hello</code> message. If you don't enable SNI, the status of the health check will be <code>SSL alert handshake_failure</code>. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS certificate on your endpoint includes a domain name in the <code>Common Name</code> field and possibly several more in the <code>Subject Alternative Names</code> field. One of the domain names in the certificate should match the value that you specify for <code>FullyQualifiedDomainName</code>. If the endpoint responds to the <code>client_hello</code> message with a certificate that does not include the domain name that you specified in <code>FullyQualifiedDomainName</code>, a health checker will retry the handshake. In the second attempt, the health checker will omit <code>FullyQualifiedDomainName</code> from the <code>client_hello</code> message. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_FailureThreshold</name> <description> <para>The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Amazon Route 53 Developer Guide</i>. If you don't specify a value for <code>FailureThreshold</code>, the default value is three health checks. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_FullyQualifiedDomainName</name> <description> <para>Amazon Route 53 behavior depends on whether you specify a value for <code>IPAddress</code>. <b>If you specify a value for</b><code>IPAddress</code>: Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of <code>FullyQualifiedDomainName</code> in the <code>Host</code> header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks. When Amazon Route 53 checks the health of an endpoint, here is how it constructs the <code>Host</code> header: - If you specify a value of <code>80</code> for <code>Port</code> and <code>HTTP</code> or <code>HTTP_STR_MATCH</code> for <code>Type</code>, Amazon Route 53 passes the value of <code>FullyQualifiedDomainName</code> to the endpoint in the Host header. - If you specify a value of <code>443</code> for <code>Port</code> and <code>HTTPS</code> or <code>HTTPS_STR_MATCH</code> for <code>Type</code>, Amazon Route 53 passes the value of <code>FullyQualifiedDomainName</code> to the endpoint in the <code>Host</code> header. - If you specify another value for <code>Port</code> and any value except <code>TCP</code> for <code>Type</code>, Amazon Route 53 passes <code>FullyQualifiedDomainName:Port</code> to the endpoint in the <code>Host</code> header. If you don't specify a value for <code>FullyQualifiedDomainName</code>, Amazon Route 53 substitutes the value of <code>IPAddress</code> in the <code>Host</code> header in each of the preceding cases. <b>If you don't specify a value for <code>IPAddress</code></b>: Amazon Route 53 sends a DNS request to the domain that you specify for <code>FullyQualifiedDomainName</code> at the interval that you specify for <code>RequestInterval</code>. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint. If you don't specify a value for <code>IPAddress</code>, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for <code>FullyQualifiedDomainName</code>, the health check fails with a "DNS resolution failed" error. If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by <code>FullyQualifiedDomainName</code>, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of <code>FullyQualifiedDomainName</code>, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com). <important><para>In this configuration, if you create a health check for which the value of <code>FullyQualifiedDomainName</code> matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.</para></important> In addition, if the value that you specify for <code>Type</code> is <code>HTTP</code>, <code>HTTPS</code>, <code>HTTP_STR_MATCH</code>, or <code>HTTPS_STR_MATCH</code>, Amazon Route 53 passes the value of <code>FullyQualifiedDomainName</code> in the <code>Host</code> header, as it does when you specify a value for <code>IPAddress</code>. If the value of <code>Type</code> is <code>TCP</code>, Amazon Route 53 doesn't pass a <code>Host</code> header. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_HealthThreshold</name> <description> <para>The number of child health checks that are associated with a <code>CALCULATED</code> health that Amazon Route 53 must consider healthy for the <code>CALCULATED</code> health check to be considered healthy. To specify the child health checks that you want to associate with a <code>CALCULATED</code> health check, use the <a>HealthCheckConfig$ChildHealthChecks</a> and <a>HealthCheckConfig$ChildHealthChecks</a> elements. Note the following: - If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy. - If you specify <code>0</code>, Amazon Route 53 always considers this health check to be healthy. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_InsufficientDataHealthStatus</name> <description> <para>When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: - <code>Healthy</code>: Amazon Route 53 considers the health check to be healthy. - <code>Unhealthy</code>: Amazon Route 53 considers the health check to be unhealthy. - <code>LastKnownStatus</code>: Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.InsufficientDataHealthStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_Inverted</name> <description> <para>Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_IPAddress</name> <description> <para>The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for <code>IPAddress</code>, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in <code>FullyQualifiedDomainName</code> at the interval that you specify in <code>RequestInterval</code>. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint. Use one of the following formats for the value of <code>IPAddress</code>: - <b>IPv4 address</b>: four values between 0 and 255, separated by periods (.), for example, <code>192.0.2.44</code>. - <b>IPv6 address</b>: eight groups of four hexadecimal values, separated by colons (:), for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>. You can also shorten IPv6 addresses as described in RFC 5952, for example, <code>2001:db8:85a3::abcd:1:2345</code>. If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for <code>IPAddress</code>. This ensures that the IP address of your instance will never change. For more information, see <a>HealthCheckConfig$FullyQualifiedDomainName</a>. Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: - <a href="https://tools.ietf.org/html/rfc5735">RFC 5735, Special Use IPv4 Addresses</a> - <a href="https://tools.ietf.org/html/rfc6598">RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space</a> - <a href="https://tools.ietf.org/html/rfc5156">RFC 5156, Special-Use IPv6 Addresses</a> When the value of <code>Type</code> is <code>CALCULATED</code> or <code>CLOUDWATCH_METRIC</code>, omit <code>IPAddress</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_MeasureLatency</name> <description> <para>Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the <b>Health Checks</b> page in the Amazon Route 53 console. <important><para>You can't change the value of <code>MeasureLatency</code> after you create a health check.</para></important> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AlarmIdentifier_Name</name> <description> <para>The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_Port</name> <description> <para>The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for <code>Port</code> only when you specify a value for <code>IPAddress</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AlarmIdentifier_Region</name> <description> <para>A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. For the current list of CloudWatch regions, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cw_region">Amazon CloudWatch</a> in the <i>AWS Regions and Endpoints</i> chapter of the <i>Amazon Web Services General Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.CloudWatchRegion</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_Region</name> <description> <para>A complex type that contains one <code>Region</code> element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint. If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under <b>Valid Values</b>. If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions). </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_RequestInterval</name> <description> <para>The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Amazon Route 53 health checker makes requests at this interval. <important><para>You can't change the value of <code>RequestInterval</code> after you create a health check.</para></important> If you don't specify a value for <code>RequestInterval</code>, the default value is <code>30</code> seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_ResourcePath</name> <description> <para>The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_SearchString</name> <description> <para>If the value of Type is <code>HTTP_STR_MATCH</code> or <code>HTTP_STR_MATCH</code>, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for <code>SearchString</code> in the response body. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_Type</name> <description> <para>The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy. <important><para>You can't change the value of <code>Type</code> after you create a health check.</para></important> You can create the following types of health checks: - <b>HTTP</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. - <b>HTTPS</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. <important><para>If you specify <code>HTTPS</code> for the value of <code>Type</code>, the endpoint must support TLS v1.0 or later.</para></important> - <b>HTTP_STR_MATCH</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in <code>SearchString</code>. - <b>HTTPS_STR_MATCH</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an <code>HTTPS</code> request and searches the first 5,120 bytes of the response body for the string that you specify in <code>SearchString</code>. - <b>TCP</b>: Amazon Route 53 tries to establish a TCP connection. - <b>CLOUDWATCH_METRIC</b>: The health check is associated with a CloudWatch alarm. If the state of the alarm is <code>OK</code>, the health check is considered healthy. If the state is <code>ALARM</code>, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is <code>OK</code> or <code>ALARM</code>, the health check status depends on the setting for <code>InsufficientDataHealthStatus</code>: <code>Healthy</code>, <code>Unhealthy</code>, or <code>LastKnownStatus</code>. - <b>CALCULATED</b>: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of <code>HealthThreshold</code>. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Amazon Route 53 Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.HealthCheckType</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AlarmIdentifier_Name</name> <description> <para>The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. </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="False" position="Named"> <name>AlarmIdentifier_Region</name> <description> <para>A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. For the current list of CloudWatch regions, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cw_region">Amazon CloudWatch</a> in the <i>AWS Regions and Endpoints</i> chapter of the <i>Amazon Web Services General Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.CloudWatchRegion</parameterValue> <type> <name>Amazon.Route53.CloudWatchRegion</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CallerReference</name> <description> <para>A unique string that identifies the request and that allows you to retry a failed <code>CreateHealthCheck</code> request without the risk of creating two identical health checks: - If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Amazon Route 53 returns the settings for the existing health check. - If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> as a deleted health check, regardless of the settings, Amazon Route 53 returns a <code>HealthCheckAlreadyExists</code> error. - If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> as an existing health check but with different settings, Amazon Route 53 returns a <code>HealthCheckAlreadyExists</code> error. - If you send a <code>CreateHealthCheck</code> request with a unique <code>CallerReference</code> but settings identical to an existing health check, Amazon Route 53 creates the health check. </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="False" position="Named"> <name>HealthCheckConfig_ChildHealthCheck</name> <description> <para>(CALCULATED Health Checks Only) A complex type that contains one <code>ChildHealthCheck</code> element for each health check that you want to associate with a <code>CALCULATED</code> health check. </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="False" position="Named"> <name>HealthCheckConfig_EnableSNI</name> <description> <para>Specify whether you want Amazon Route 53 to send the value of <code>FullyQualifiedDomainName</code> to the endpoint in the <code>client_hello</code> message during TLS negotiation. This allows the endpoint to respond to <code>HTTPS</code> health check requests with the applicable SSL/TLS certificate. Some endpoints require that <code>HTTPS</code> requests include the host name in the <code>client_hello</code> message. If you don't enable SNI, the status of the health check will be <code>SSL alert handshake_failure</code>. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS certificate on your endpoint includes a domain name in the <code>Common Name</code> field and possibly several more in the <code>Subject Alternative Names</code> field. One of the domain names in the certificate should match the value that you specify for <code>FullyQualifiedDomainName</code>. If the endpoint responds to the <code>client_hello</code> message with a certificate that does not include the domain name that you specified in <code>FullyQualifiedDomainName</code>, a health checker will retry the handshake. In the second attempt, the health checker will omit <code>FullyQualifiedDomainName</code> from the <code>client_hello</code> message. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_FailureThreshold</name> <description> <para>The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Amazon Route 53 Developer Guide</i>. If you don't specify a value for <code>FailureThreshold</code>, the default value is three health checks. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_FullyQualifiedDomainName</name> <description> <para>Amazon Route 53 behavior depends on whether you specify a value for <code>IPAddress</code>. <b>If you specify a value for</b><code>IPAddress</code>: Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of <code>FullyQualifiedDomainName</code> in the <code>Host</code> header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks. When Amazon Route 53 checks the health of an endpoint, here is how it constructs the <code>Host</code> header: - If you specify a value of <code>80</code> for <code>Port</code> and <code>HTTP</code> or <code>HTTP_STR_MATCH</code> for <code>Type</code>, Amazon Route 53 passes the value of <code>FullyQualifiedDomainName</code> to the endpoint in the Host header. - If you specify a value of <code>443</code> for <code>Port</code> and <code>HTTPS</code> or <code>HTTPS_STR_MATCH</code> for <code>Type</code>, Amazon Route 53 passes the value of <code>FullyQualifiedDomainName</code> to the endpoint in the <code>Host</code> header. - If you specify another value for <code>Port</code> and any value except <code>TCP</code> for <code>Type</code>, Amazon Route 53 passes <code>FullyQualifiedDomainName:Port</code> to the endpoint in the <code>Host</code> header. If you don't specify a value for <code>FullyQualifiedDomainName</code>, Amazon Route 53 substitutes the value of <code>IPAddress</code> in the <code>Host</code> header in each of the preceding cases. <b>If you don't specify a value for <code>IPAddress</code></b>: Amazon Route 53 sends a DNS request to the domain that you specify for <code>FullyQualifiedDomainName</code> at the interval that you specify for <code>RequestInterval</code>. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint. If you don't specify a value for <code>IPAddress</code>, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for <code>FullyQualifiedDomainName</code>, the health check fails with a "DNS resolution failed" error. If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by <code>FullyQualifiedDomainName</code>, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of <code>FullyQualifiedDomainName</code>, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com). <important><para>In this configuration, if you create a health check for which the value of <code>FullyQualifiedDomainName</code> matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.</para></important> In addition, if the value that you specify for <code>Type</code> is <code>HTTP</code>, <code>HTTPS</code>, <code>HTTP_STR_MATCH</code>, or <code>HTTPS_STR_MATCH</code>, Amazon Route 53 passes the value of <code>FullyQualifiedDomainName</code> in the <code>Host</code> header, as it does when you specify a value for <code>IPAddress</code>. If the value of <code>Type</code> is <code>TCP</code>, Amazon Route 53 doesn't pass a <code>Host</code> header. </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="False" position="Named"> <name>HealthCheckConfig_HealthThreshold</name> <description> <para>The number of child health checks that are associated with a <code>CALCULATED</code> health that Amazon Route 53 must consider healthy for the <code>CALCULATED</code> health check to be considered healthy. To specify the child health checks that you want to associate with a <code>CALCULATED</code> health check, use the <a>HealthCheckConfig$ChildHealthChecks</a> and <a>HealthCheckConfig$ChildHealthChecks</a> elements. Note the following: - If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy. - If you specify <code>0</code>, Amazon Route 53 always considers this health check to be healthy. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_InsufficientDataHealthStatus</name> <description> <para>When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: - <code>Healthy</code>: Amazon Route 53 considers the health check to be healthy. - <code>Unhealthy</code>: Amazon Route 53 considers the health check to be unhealthy. - <code>LastKnownStatus</code>: Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.InsufficientDataHealthStatus</parameterValue> <type> <name>Amazon.Route53.InsufficientDataHealthStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_Inverted</name> <description> <para>Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_IPAddress</name> <description> <para>The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for <code>IPAddress</code>, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in <code>FullyQualifiedDomainName</code> at the interval that you specify in <code>RequestInterval</code>. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint. Use one of the following formats for the value of <code>IPAddress</code>: - <b>IPv4 address</b>: four values between 0 and 255, separated by periods (.), for example, <code>192.0.2.44</code>. - <b>IPv6 address</b>: eight groups of four hexadecimal values, separated by colons (:), for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>. You can also shorten IPv6 addresses as described in RFC 5952, for example, <code>2001:db8:85a3::abcd:1:2345</code>. If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for <code>IPAddress</code>. This ensures that the IP address of your instance will never change. For more information, see <a>HealthCheckConfig$FullyQualifiedDomainName</a>. Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: - <a href="https://tools.ietf.org/html/rfc5735">RFC 5735, Special Use IPv4 Addresses</a> - <a href="https://tools.ietf.org/html/rfc6598">RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space</a> - <a href="https://tools.ietf.org/html/rfc5156">RFC 5156, Special-Use IPv6 Addresses</a> When the value of <code>Type</code> is <code>CALCULATED</code> or <code>CLOUDWATCH_METRIC</code>, omit <code>IPAddress</code>. </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="False" position="Named"> <name>HealthCheckConfig_MeasureLatency</name> <description> <para>Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the <b>Health Checks</b> page in the Amazon Route 53 console. <important><para>You can't change the value of <code>MeasureLatency</code> after you create a health check.</para></important> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_Port</name> <description> <para>The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for <code>Port</code> only when you specify a value for <code>IPAddress</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_Region</name> <description> <para>A complex type that contains one <code>Region</code> element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint. If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under <b>Valid Values</b>. If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions). </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="False" position="Named"> <name>HealthCheckConfig_RequestInterval</name> <description> <para>The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Amazon Route 53 health checker makes requests at this interval. <important><para>You can't change the value of <code>RequestInterval</code> after you create a health check.</para></important> If you don't specify a value for <code>RequestInterval</code>, the default value is <code>30</code> seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HealthCheckConfig_ResourcePath</name> <description> <para>The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. </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="False" position="Named"> <name>HealthCheckConfig_SearchString</name> <description> <para>If the value of Type is <code>HTTP_STR_MATCH</code> or <code>HTTP_STR_MATCH</code>, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for <code>SearchString</code> in the response body. </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="False" position="Named"> <name>HealthCheckConfig_Type</name> <description> <para>The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy. <important><para>You can't change the value of <code>Type</code> after you create a health check.</para></important> You can create the following types of health checks: - <b>HTTP</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. - <b>HTTPS</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. <important><para>If you specify <code>HTTPS</code> for the value of <code>Type</code>, the endpoint must support TLS v1.0 or later.</para></important> - <b>HTTP_STR_MATCH</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in <code>SearchString</code>. - <b>HTTPS_STR_MATCH</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an <code>HTTPS</code> request and searches the first 5,120 bytes of the response body for the string that you specify in <code>SearchString</code>. - <b>TCP</b>: Amazon Route 53 tries to establish a TCP connection. - <b>CLOUDWATCH_METRIC</b>: The health check is associated with a CloudWatch alarm. If the state of the alarm is <code>OK</code>, the health check is considered healthy. If the state is <code>ALARM</code>, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is <code>OK</code> or <code>ALARM</code>, the health check status depends on the setting for <code>InsufficientDataHealthStatus</code>: <code>Healthy</code>, <code>Unhealthy</code>, or <code>LastKnownStatus</code>. - <b>CALCULATED</b>: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of <code>HealthThreshold</code>. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Amazon Route 53 Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.HealthCheckType</parameterValue> <type> <name>Amazon.Route53.HealthCheckType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.CreateHealthCheckResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.CreateHealthCheckResponse 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=New-R53HealthCheck.html&tocid=New-R53HealthCheck</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>New-R53HostedZone</name> <description> <para>Invokes the CreateHostedZone operation against Amazon Route 53.</para> </description> <verb>New</verb> <noun>R53HostedZone</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new public hosted zone, which you use to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains. <important><para> You can't convert a public hosted zones to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets. </para></important> For more information about charges for hosted zones, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>. Note the following: - You can't create a hosted zone for a top-level domain (TLD). - Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html">NS and SOA Records that Amazon Route 53 Creates for a Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>. If you want to use the same name servers for multiple hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the <code>DelegationSetId</code> element. - If your domain is registered with a registrar other than Amazon Route 53, you must update the name servers with your registrar to make Amazon Route 53 your DNS service. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/creating-migrating.html">Configuring Amazon Route 53 as your DNS Service</a> in the <i>Amazon Route 53 Developer Guide</i>. When you submit a <code>CreateHostedZone</code> request, the initial status of the hosted zone is <code>PENDING</code>. This means that the NS and SOA records are not yet available on all Amazon Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to <code>INSYNC</code>. </para> </description> <syntax> <syntaxItem> <name>New-R53HostedZone</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the domain. For resource record types that include a domain name, specify a fully qualified domain name, for example, <i>www.example.com</i>. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats <i>www.example.com</i> (without a trailing dot) and <i>www.example.com.</i> (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Amazon Route 53, change the name servers for your domain to the set of <code>NameServers</code> that <code>CreateHostedZone</code> returns in <code>DelegationSet</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>CallerReference</name> <description> <para>A unique string that identifies the request and that allows failed <code>CreateHostedZone</code> requests to be retried without the risk of executing the operation twice. You must use a unique <code>CallerReference</code> string every time you submit a <code>CreateHostedZone</code> request. <code>CallerReference</code> can be any unique string, for example, a date/time stamp. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>HostedZoneConfig_Comment</name> <description> <para>Any comments that you want to include about the hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DelegationSetId</name> <description> <para>If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see <a>CreateReusableDelegationSet</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostedZoneConfig_PrivateZone</name> <description> <para>A value that indicates whether this is a private hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>CallerReference</name> <description> <para>A unique string that identifies the request and that allows failed <code>CreateHostedZone</code> requests to be retried without the risk of executing the operation twice. You must use a unique <code>CallerReference</code> string every time you submit a <code>CreateHostedZone</code> request. <code>CallerReference</code> can be any unique string, for example, a date/time stamp. </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="False" position="Named"> <name>DelegationSetId</name> <description> <para>If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see <a>CreateReusableDelegationSet</a>. </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="False" 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="False" position="3"> <name>HostedZoneConfig_Comment</name> <description> <para>Any comments that you want to include about the hosted zone. </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="False" position="Named"> <name>HostedZoneConfig_PrivateZone</name> <description> <para>A value that indicates whether this is a private hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the domain. For resource record types that include a domain name, specify a fully qualified domain name, for example, <i>www.example.com</i>. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats <i>www.example.com</i> (without a trailing dot) and <i>www.example.com.</i> (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Amazon Route 53, change the name servers for your domain to the set of <code>NameServers</code> that <code>CreateHostedZone</code> returns in <code>DelegationSet</code>. </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="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> <type> <name>Amazon.Route53.VPCRegion</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.CreateHostedZoneResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.CreateHostedZoneResponse 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=New-R53HostedZone.html&tocid=New-R53HostedZone</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\>$params = @{ Name="example.com" CallerReference="myUniqueIdentifier" HostedZoneConfig_Comment="This is my first hosted zone" DelegationSetId="NZ8X2CISAMPLE" VPC_VPCId="vpc-1a2b3c4d" VPC_VPCRegion="us-east-1" } PS C:\>New-R53HostedZone @params</code><remarks><para>Description</para><para>-----------</para><para>Creates a new hosted zone named 'example.com', associated with a reusable delegation set. Note that you must supply a value for the CallerReference parameter so that requests that need to be retried if necessary without the risk of executing the operation twice. Because the hosted zone is being created in a VPC it is automatically private and you should not set the -HostedZoneConfig_PrivateZone parameter.</para><para /><para /></remarks> </example> </examples> </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>New-R53QueryLoggingConfig</name> <description> <para>Invokes the CreateQueryLoggingConfig operation against Amazon Route 53.</para> </description> <verb>New</verb> <noun>R53QueryLoggingConfig</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Amazon Route 53 receives for a specified public hosted zone, such as the following: - Amazon Route 53 edge location that responded to the DNS query - Domain or subdomain that was requested - DNS record type, such as A or AAAA - DNS response code, such as <code>NoError</code> or <code>ServFail</code> Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Amazon Route 53 console, Amazon Route 53 performs these operations automatically. - Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: - You must create the log group in the us-east-1 region. - You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for. - When you create log groups for query logging, we recommend that you use a consistent prefix, for example: <code>/aws/route53/<i>hosted zone name</i></code> In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Amazon Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. - Create a CloudWatch Logs resource policy, and give it the permissions that Amazon Route 53 needs to create log streams and to to send query logs to log streams. For the value of <code>Resource</code>, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with <code>*</code>, for example: <code>arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*</code> You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI. Log Streams and Edge Locations When Amazon Route 53 finishes creating the configuration for DNS query logging, it does the following: - Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Amazon Route 53 responds to for that edge location. - Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: <code><i>hosted zone ID</i>/<i>edge location code</i></code> The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Amazon Route 53 Global Network" on the <a href="http://aws.amazon.com/route53/details/">Amazon Route 53 Product Details</a> page. Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Amazon Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Amazon Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html">Routing Internet Traffic to Your Website or Web Application</a> in the <i>Amazon Route 53 Developer Guide</i>. Log File Format For a list of the values in each query log and the format of each value, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html">Logging DNS Queries</a> in the <i>Amazon Route 53 Developer Guide</i>. Pricing For information about charges for query logs, see <a href="http://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. How to Stop Logging If you want Amazon Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see <a>DeleteQueryLoggingConfig</a>. </para> </description> <syntax> <syntaxItem> <name>New-R53QueryLoggingConfig</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsLogGroupArn</name> <description> <para>The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN: arn:aws:logs:<i>region</i>:<i>account-id</i>:log-group:<i>log_group_name</i> To get the ARN for a log group, you can use the CloudWatch console, the <a href="http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html">DescribeLogGroups</a> API action, the <a href="http://docs.aws.amazon.com/cli/latest/reference/logs/describe-log-groups.html">describe-log-groups</a> command, or the applicable command in one of the AWS SDKs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsLogGroupArn</name> <description> <para>The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN: arn:aws:logs:<i>region</i>:<i>account-id</i>:log-group:<i>log_group_name</i> To get the ARN for a log group, you can use the CloudWatch console, the <a href="http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html">DescribeLogGroups</a> API action, the <a href="http://docs.aws.amazon.com/cli/latest/reference/logs/describe-log-groups.html">describe-log-groups</a> command, or the applicable command in one of the AWS SDKs. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones. </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.Route53.Model.CreateQueryLoggingConfigResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.CreateQueryLoggingConfigResponse 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=New-R53QueryLoggingConfig.html&tocid=New-R53QueryLoggingConfig</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>New-R53ReusableDelegationSet</name> <description> <para>Invokes the CreateReusableDelegationSet operation against Amazon Route 53.</para> </description> <verb>New</verb> <noun>R53ReusableDelegationSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, <code>CreateReusableDelegationSet</code> marks the delegation set associated with that zone as reusable A reusable delegation set can't be associated with a private hosted zone. For information on how to use a reusable delegation set to configure white label name servers, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/white-label-name-servers.html">Configuring White Label Name Servers</a>. </para> </description> <syntax> <syntaxItem> <name>New-R53ReusableDelegationSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CallerReference</name> <description> <para>A unique string that identifies the request, and that allows you to retry failed <code>CreateReusableDelegationSet</code> requests without the risk of executing the operation twice. You must use a unique <code>CallerReference</code> string every time you submit a <code>CreateReusableDelegationSet</code> request. <code>CallerReference</code> can be any unique string, for example a date/time stamp. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CallerReference</name> <description> <para>A unique string that identifies the request, and that allows you to retry failed <code>CreateReusableDelegationSet</code> requests without the risk of executing the operation twice. You must use a unique <code>CallerReference</code> string every time you submit a <code>CreateReusableDelegationSet</code> request. <code>CallerReference</code> can be any unique string, for example a date/time stamp. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone. </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.Route53.Model.CreateReusableDelegationSetResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.CreateReusableDelegationSetResponse 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=New-R53ReusableDelegationSet.html&tocid=New-R53ReusableDelegationSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>New-R53TrafficPolicy</name> <description> <para>Invokes the CreateTrafficPolicy operation against Amazon Route 53.</para> </description> <verb>New</verb> <noun>R53TrafficPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). </para> </description> <syntax> <syntaxItem> <name>New-R53TrafficPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the traffic policy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>(Optional) Any comments that you want to include about the traffic policy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Document</name> <description> <para>The definition of this traffic policy in JSON format. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html">Traffic Policy Document Format</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>(Optional) Any comments that you want to include about the traffic policy. </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="False" position="Named"> <name>Document</name> <description> <para>The definition of this traffic policy in JSON format. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html">Traffic Policy Document Format</a>. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the traffic policy. </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.Route53.Model.CreateTrafficPolicyResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.CreateTrafficPolicyResponse 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=New-R53TrafficPolicy.html&tocid=New-R53TrafficPolicy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>New-R53TrafficPolicyInstance</name> <description> <para>Invokes the CreateTrafficPolicyInstance operation against Amazon Route 53.</para> </description> <verb>New</verb> <noun>R53TrafficPolicyInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, <code>CreateTrafficPolicyInstance</code> associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that <code>CreateTrafficPolicyInstance</code> created. </para> </description> <syntax> <syntaxItem> <name>New-R53TrafficPolicyInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyId</name> <description> <para>The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyVersion</name> <description> <para>The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TTL</name> <description> <para>(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>HostedZoneId</name> <description> <para>The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy. </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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance. </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="False" position="Named"> <name>TrafficPolicyId</name> <description> <para>The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone. </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="False" position="Named"> <name>TrafficPolicyVersion</name> <description> <para>The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TTL</name> <description> <para>(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.CreateTrafficPolicyInstanceResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.CreateTrafficPolicyInstanceResponse 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=New-R53TrafficPolicyInstance.html&tocid=New-R53TrafficPolicyInstance</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>New-R53TrafficPolicyVersion</name> <description> <para>Invokes the CreateTrafficPolicyVersion operation against Amazon Route 53.</para> </description> <verb>New</verb> <noun>R53TrafficPolicyVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy. </para> </description> <syntax> <syntaxItem> <name>New-R53TrafficPolicyVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy for which you want to create a new version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>The comment that you specified in the <code>CreateTrafficPolicyVersion</code> request, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Document</name> <description> <para>The definition of this version of the traffic policy, in JSON format. You specified the JSON in the <code>CreateTrafficPolicyVersion</code> request. For more information about the JSON format, see <a>CreateTrafficPolicy</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>The comment that you specified in the <code>CreateTrafficPolicyVersion</code> request, if any. </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="False" position="Named"> <name>Document</name> <description> <para>The definition of this version of the traffic policy, in JSON format. You specified the JSON in the <code>CreateTrafficPolicyVersion</code> request. For more information about the JSON format, see <a>CreateTrafficPolicy</a>. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy for which you want to create a new version. </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.Route53.Model.CreateTrafficPolicyVersionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.CreateTrafficPolicyVersionResponse 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=New-R53TrafficPolicyVersion.html&tocid=New-R53TrafficPolicyVersion</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>New-R53VPCAssociationAuthorization</name> <description> <para>Invokes the CreateVPCAssociationAuthorization operation against Amazon Route 53.</para> </description> <verb>New</verb> <noun>R53VPCAssociationAuthorization</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Authorizes the AWS account that created a specified VPC to submit an <code>AssociateVPCWithHostedZone</code> request to associate the VPC with a specified hosted zone that was created by a different account. To submit a <code>CreateVPCAssociationAuthorization</code> request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an <code>AssociateVPCWithHostedZone</code> request. If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC. </para> </description> <syntax> <syntaxItem> <name>New-R53VPCAssociationAuthorization</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HostedZoneId</name> <description> <para>The ID of the private hosted zone that you want to authorize associating a VPC with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>HostedZoneId</name> <description> <para>The ID of the private hosted zone that you want to authorize associating a VPC with. </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="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> <type> <name>Amazon.Route53.VPCRegion</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.CreateVPCAssociationAuthorizationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.CreateVPCAssociationAuthorizationResponse 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=New-R53VPCAssociationAuthorization.html&tocid=New-R53VPCAssociationAuthorization</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Register-R53VPCWithHostedZone</name> <description> <para>Invokes the AssociateVPCWithHostedZone operation against Amazon Route 53.</para> </description> <verb>Register</verb> <noun>R53VPCWithHostedZone</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates an Amazon VPC with a private hosted zone. <important><para> To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone. </para></important> If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a <code>CreateVPCAssociationAuthorization</code> request. Then the account that created the VPC must submit an <code>AssociateVPCWithHostedZone</code> request. </para> </description> <syntax> <syntaxItem> <name>Register-R53VPCWithHostedZone</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the private hosted zone that you want to associate an Amazon VPC with. Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para><i>Optional:</i> A comment about the association request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para><i>Optional:</i> A comment about the association request. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the private hosted zone that you want to associate an Amazon VPC with. Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association. </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="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> <type> <name>Amazon.Route53.VPCRegion</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.ChangeInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ChangeInfo object. The service call response (type Amazon.Route53.Model.AssociateVPCWithHostedZoneResponse) 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=Register-R53VPCWithHostedZone.html&tocid=Register-R53VPCWithHostedZone</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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-R53HealthCheck</name> <description> <para>Invokes the DeleteHealthCheck operation against Amazon Route 53.</para> </description> <verb>Remove</verb> <noun>R53HealthCheck</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a health check. <important><para> Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-deleting.html#health-checks-deleting.html">Replacing and Deleting Health Checks</a> in the <i>Amazon Route 53 Developer Guide</i>. </para></important> </para> </description> <syntax> <syntaxItem> <name>Remove-R53HealthCheck</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The ID of the health check that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HealthCheckId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>HealthCheckId</name> <description> <para>The ID of the health check that you want to delete. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HealthCheckId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the HealthCheckId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53.Model.DeleteHealthCheckResponse) 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-R53HealthCheck.html&tocid=Remove-R53HealthCheck</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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-R53HostedZone</name> <description> <para>Invokes the DeleteHostedZone operation against Amazon Route 53.</para> </description> <verb>Remove</verb> <noun>R53HostedZone</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a hosted zone. <important><para> If the name servers for the hosted zone are associated with a domain and if you want to make the domain unavailable on the Internet, we recommend that you delete the name servers from the domain to prevent future DNS queries from possibly being misrouted. If the domain is registered with Amazon Route 53, see <code>UpdateDomainNameservers</code>. If the domain is registered with another registrar, use the method provided by the registrar to delete name servers for the domain. </para><para> Some domain registries don't allow you to remove all of the name servers for a domain. If the registry for your domain requires one or more name servers, we recommend that you delete the hosted zone only if you transfer DNS service to another service provider, and you replace the name servers for the domain with name servers from the new provider. </para></important> You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Amazon Route 53 returns a <code>HostedZoneNotEmpty</code> error. For information about deleting records from your hosted zone, see <a>ChangeResourceRecordSets</a>. To verify that the hosted zone has been deleted, do one of the following: - Use the <code>GetHostedZone</code> action to request information about the hosted zone. - Use the <code>ListHostedZones</code> action to get a list of the hosted zones associated with the current AWS account. </para> </description> <syntax> <syntaxItem> <name>Remove-R53HostedZone</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the hosted zone you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the hosted zone you want to delete. </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.Route53.Model.ChangeInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ChangeInfo object. The service call response (type Amazon.Route53.Model.DeleteHostedZoneResponse) 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=Remove-R53HostedZone.html&tocid=Remove-R53HostedZone</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Remove-R53HostedZone -Id Z1PA6795UKMFR9</code><remarks><para>Description</para><para>-----------</para><para>Deletes the hosted zone with the specified ID. You will be prompted for confirmation before the command proceeds unless you add the -Force switch parameter.</para><para /><para /></remarks> </example> </examples> </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-R53QueryLoggingConfig</name> <description> <para>Invokes the DeleteQueryLoggingConfig operation against Amazon Route 53.</para> </description> <verb>Remove</verb> <noun>R53QueryLoggingConfig</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Amazon Route 53 doesn't delete any logs that are already in CloudWatch Logs. For more information about DNS query logs, see <a>CreateQueryLoggingConfig</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-R53QueryLoggingConfig</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the configuration that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the configuration that you want to delete. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Id parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53.Model.DeleteQueryLoggingConfigResponse) 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-R53QueryLoggingConfig.html&tocid=Remove-R53QueryLoggingConfig</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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-R53ReusableDelegationSet</name> <description> <para>Invokes the DeleteReusableDelegationSet operation against Amazon Route 53.</para> </description> <verb>Remove</verb> <noun>R53ReusableDelegationSet</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a reusable delegation set. <important><para> You can delete a reusable delegation set only if it isn't associated with any hosted zones. </para></important> To verify that the reusable delegation set is not associated with any hosted zones, submit a <a>GetReusableDelegationSet</a> request and specify the ID of the reusable delegation set that you want to delete. </para> </description> <syntax> <syntaxItem> <name>Remove-R53ReusableDelegationSet</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the reusable delegation set that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the reusable delegation set that you want to delete. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Id parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53.Model.DeleteReusableDelegationSetResponse) 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-R53ReusableDelegationSet.html&tocid=Remove-R53ReusableDelegationSet</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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-R53TrafficPolicy</name> <description> <para>Invokes the DeleteTrafficPolicy operation against Amazon Route 53.</para> </description> <verb>Remove</verb> <noun>R53TrafficPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a traffic policy. </para> </description> <syntax> <syntaxItem> <name>Remove-R53TrafficPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>The version number of the traffic policy that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy that you want to delete. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Version</name> <description> <para>The version number of the traffic policy that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Id parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53.Model.DeleteTrafficPolicyResponse) 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-R53TrafficPolicy.html&tocid=Remove-R53TrafficPolicy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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-R53TrafficPolicyInstance</name> <description> <para>Invokes the DeleteTrafficPolicyInstance operation against Amazon Route 53.</para> </description> <verb>Remove</verb> <noun>R53TrafficPolicyInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance. In the Amazon Route 53 console, traffic policy instances are known as policy records. </para> </description> <syntax> <syntaxItem> <name>Remove-R53TrafficPolicyInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy instance that you want to delete. <important><para>When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.</para></important> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy instance that you want to delete. <important><para>When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.</para></important> </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Id parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53.Model.DeleteTrafficPolicyInstanceResponse) 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-R53TrafficPolicyInstance.html&tocid=Remove-R53TrafficPolicyInstance</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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-R53VPCAssociationAuthorization</name> <description> <para>Invokes the DeleteVPCAssociationAuthorization operation against Amazon Route 53.</para> </description> <verb>Remove</verb> <noun>R53VPCAssociationAuthorization</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes authorization to submit an <code>AssociateVPCWithHostedZone</code> request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a <code>DeleteVPCAssociationAuthorization</code> request. <important><para> Sending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, <code>DeleteVPCAssociationAuthorization</code> won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use <code>DisassociateVPCFromHostedZone</code>. </para></important> </para> </description> <syntax> <syntaxItem> <name>Remove-R53VPCAssociationAuthorization</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HostedZoneId</name> <description> <para>When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>HostedZoneId</name> <description> <para>When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone. </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="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> <type> <name>Amazon.Route53.VPCRegion</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.Route53.Model.DeleteVPCAssociationAuthorizationResponse) 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-R53VPCAssociationAuthorization.html&tocid=Remove-R53VPCAssociationAuthorization</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Test-R53DNSAnswer</name> <description> <para>Invokes the TestDNSAnswer operation against Amazon Route 53.</para> </description> <verb>Test</verb> <noun>R53DNSAnswer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. </para> </description> <syntax> <syntaxItem> <name>Test-R53DNSAnswer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that you want Amazon Route 53 to simulate a query for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EDNS0ClientSubnetIP</name> <description> <para>If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, <code>192.0.2.44</code> or <code>2001:db8:85a3::8a2e:370:7334</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EDNS0ClientSubnetMask</name> <description> <para>If you specify an IP address for <code>edns0clientsubnetip</code>, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify <code>192.0.2.44</code> for <code>edns0clientsubnetip</code> and <code>24</code> for <code>edns0clientsubnetmask</code>, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RecordName</name> <description> <para>The name of the resource record set that you want Amazon Route 53 to simulate a query for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RecordType</name> <description> <para>The type of the resource record set. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResolverIP</name> <description> <para>If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, <code>TestDnsAnswer</code> uses the IP address of a DNS resolver in the AWS US East (N. Virginia) Region (<code>us-east-1</code>). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EDNS0ClientSubnetIP</name> <description> <para>If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, <code>192.0.2.44</code> or <code>2001:db8:85a3::8a2e:370:7334</code>. </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="False" position="Named"> <name>EDNS0ClientSubnetMask</name> <description> <para>If you specify an IP address for <code>edns0clientsubnetip</code>, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify <code>192.0.2.44</code> for <code>edns0clientsubnetip</code> and <code>24</code> for <code>edns0clientsubnetmask</code>, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses. </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 (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the hosted zone that you want Amazon Route 53 to simulate a query for. </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="False" position="Named"> <name>RecordName</name> <description> <para>The name of the resource record set that you want Amazon Route 53 to simulate a query for. </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="False" position="Named"> <name>RecordType</name> <description> <para>The type of the resource record set. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.RRType</parameterValue> <type> <name>Amazon.Route53.RRType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResolverIP</name> <description> <para>If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, <code>TestDnsAnswer</code> uses the IP address of a DNS resolver in the AWS US East (N. Virginia) Region (<code>us-east-1</code>). </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.Route53.Model.TestDNSAnswerResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53.Model.TestDNSAnswerResponse 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=Test-R53DNSAnswer.html&tocid=Test-R53DNSAnswer</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Unregister-R53VPCFromHostedZone</name> <description> <para>Invokes the DisassociateVPCFromHostedZone operation against Amazon Route 53.</para> </description> <verb>Unregister</verb> <noun>R53VPCFromHostedZone</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates a VPC from a Amazon Route 53 private hosted zone. You can't disassociate the last VPC from a private hosted zone. <important><para> You can't disassociate a VPC from a private hosted zone when only one VPC is associated with the hosted zone. You also can't convert a private hosted zone into a public hosted zone. </para></important> </para> </description> <syntax> <syntaxItem> <name>Unregister-R53VPCFromHostedZone</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the private hosted zone that you want to disassociate a VPC from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para><i>Optional:</i> A comment about the disassociation request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para><i>Optional:</i> A comment about the disassociation request. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>HostedZoneId</name> <description> <para>The ID of the private hosted zone that you want to disassociate a VPC from. </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="False" position="Named"> <name>VPC_VPCId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>VPC_VPCRegion</name> <description> <para>(Private hosted zones only) The region in which you created an Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53.VPCRegion</parameterValue> <type> <name>Amazon.Route53.VPCRegion</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.ChangeInfo</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ChangeInfo object. The service call response (type Amazon.Route53.Model.DisassociateVPCFromHostedZoneResponse) 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=Unregister-R53VPCFromHostedZone.html&tocid=Unregister-R53VPCFromHostedZone</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53HostedZoneComment</name> <description> <para>Invokes the UpdateHostedZoneComment operation against Amazon Route 53.</para> </description> <verb>Update</verb> <noun>R53HostedZoneComment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the comment for a specified hosted zone. </para> </description> <syntax> <syntaxItem> <name>Update-R53HostedZoneComment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID for the hosted zone that you want to update the comment for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>The new comment for the hosted zone. If you don't specify a value for <code>Comment</code>, Amazon Route 53 deletes the existing value of the <code>Comment</code> element, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>The new comment for the hosted zone. If you don't specify a value for <code>Comment</code>, Amazon Route 53 deletes the existing value of the <code>Comment</code> element, if any. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID for the hosted zone that you want to update the comment for. </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.Route53.Model.HostedZone</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a HostedZone object. The service call response (type Amazon.Route53.Model.UpdateHostedZoneCommentResponse) 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=Update-R53HostedZoneComment.html&tocid=Update-R53HostedZoneComment</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53TrafficPolicyComment</name> <description> <para>Invokes the UpdateTrafficPolicyComment operation against Amazon Route 53.</para> </description> <verb>Update</verb> <noun>R53TrafficPolicyComment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the comment for a specified traffic policy version. </para> </description> <syntax> <syntaxItem> <name>Update-R53TrafficPolicyComment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The value of <code>Id</code> for the traffic policy that you want to update the comment for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>The new comment for the specified traffic policy and version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>The value of <code>Version</code> for the traffic policy that you want to update the comment for. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Comment</name> <description> <para>The new comment for the specified traffic policy and version. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The value of <code>Id</code> for the traffic policy that you want to update the comment for. </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="False" position="Named"> <name>Version</name> <description> <para>The value of <code>Version</code> for the traffic policy that you want to update the comment for. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.TrafficPolicy</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TrafficPolicy object. The service call response (type Amazon.Route53.Model.UpdateTrafficPolicyCommentResponse) 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=Update-R53TrafficPolicyComment.html&tocid=Update-R53TrafficPolicyComment</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53TrafficPolicyInstance</name> <description> <para>Invokes the UpdateTrafficPolicyInstance operation against Amazon Route 53.</para> </description> <verb>Update</verb> <noun>R53TrafficPolicyInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version. When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations: - Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets. - When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets. - Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name. </para> </description> <syntax> <syntaxItem> <name>Update-R53TrafficPolicyInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy instance that you want to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyId</name> <description> <para>The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TrafficPolicyVersion</name> <description> <para>The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TTL</name> <description> <para>The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the traffic policy instance that you want to update. </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="False" position="Named"> <name>TrafficPolicyId</name> <description> <para>The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. </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="False" position="Named"> <name>TrafficPolicyVersion</name> <description> <para>The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TTL</name> <description> <para>The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53.Model.TrafficPolicyInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TrafficPolicyInstance object. The service call response (type Amazon.Route53.Model.UpdateTrafficPolicyInstanceResponse) 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=Update-R53TrafficPolicyInstance.html&tocid=Update-R53TrafficPolicyInstance</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Disable-R53DDomainAutoRenew</name> <description> <para>Invokes the DisableDomainAutoRenew operation against Amazon Route 53 Domains.</para> </description> <verb>Disable</verb> <noun>R53DDomainAutoRenew</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation disables automatic renewal of domain registration for the specified domain. </para> </description> <syntax> <syntaxItem> <name>Disable-R53DDomainAutoRenew</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to disable automatic renewal for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to disable automatic renewal for. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DomainName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53Domains.Model.DisableDomainAutoRenewResponse) 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=Disable-R53DDomainAutoRenew.html&tocid=Disable-R53DDomainAutoRenew</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Disable-R53DDomainTransferLock</name> <description> <para>Invokes the DisableDomainTransferLock operation against Amazon Route 53 Domains.</para> </description> <verb>Disable</verb> <noun>R53DDomainTransferLock</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation removes the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </description> <syntax> <syntaxItem> <name>Disable-R53DDomainTransferLock</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to remove the transfer lock for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to remove the transfer lock for. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.DisableDomainTransferLockResponse) 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=Disable-R53DDomainTransferLock.html&tocid=Disable-R53DDomainTransferLock</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Enable-R53DDomainAutoRenew</name> <description> <para>Invokes the EnableDomainAutoRenew operation against Amazon Route 53 Domains.</para> </description> <verb>Enable</verb> <noun>R53DDomainAutoRenew</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account. The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see <a href="http://wiki.gandi.net/en/domains/renew#renewal_restoration_and_deletion_times">"Renewal, restoration, and deletion times"</a> on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline. </para> </description> <syntax> <syntaxItem> <name>Enable-R53DDomainAutoRenew</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to enable automatic renewal for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to enable automatic renewal for. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DomainName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53Domains.Model.EnableDomainAutoRenewResponse) 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=Enable-R53DDomainAutoRenew.html&tocid=Enable-R53DDomainAutoRenew</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Enable-R53DDomainTransferLock</name> <description> <para>Invokes the EnableDomainTransferLock operation against Amazon Route 53 Domains.</para> </description> <verb>Enable</verb> <noun>R53DDomainTransferLock</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation sets the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </description> <syntax> <syntaxItem> <name>Enable-R53DDomainTransferLock</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to set the transfer lock for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to set the transfer lock for. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.EnableDomainTransferLockResponse) 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=Enable-R53DDomainTransferLock.html&tocid=Enable-R53DDomainTransferLock</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DBillingRecord</name> <description> <para>Invokes the ViewBilling operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DBillingRecord</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all the domain-related billing records for the current AWS account for a specified period<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-R53DBillingRecord</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>End</name> <description> <para>The end date and time for the time period for which you want a list of billing records. Specify the date in Unix time format. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Start</name> <description> <para>The beginning date and time for the time period for which you want a list of billing records. Specify the date in Unix time format. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional billing records. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element. Constraints: The marker must match the value of <code>NextPageMarker</code> that was returned in the previous response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxItem</name> <description> <para>The number of billing records to be returned. Default: 20 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>End</name> <description> <para>The end date and time for the time period for which you want a list of billing records. Specify the date in Unix time format. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional billing records. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element. Constraints: The marker must match the value of <code>NextPageMarker</code> that was returned in the previous response. </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="False" position="Named"> <name>MaxItem</name> <description> <para>The number of billing records to be returned. Default: 20 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Start</name> <description> <para>The beginning date and time for the time period for which you want a list of billing records. Specify the date in Unix time format. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53Domains.Model.BillingRecord</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of BillingRecord objects. The service call response (type Amazon.Route53Domains.Model.ViewBillingResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53DBillingRecord.html&tocid=Get-R53DBillingRecord</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DContactReachabilityStatus</name> <description> <para>Invokes the GetContactReachabilityStatus operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DContactReachabilityStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded. If you want us to resend the email, use the <code>ResendContactReachabilityEmail</code> operation. </para> </description> <syntax> <syntaxItem> <name>Get-R53DContactReachabilityStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid. </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.Route53Domains.Model.GetContactReachabilityStatusResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53Domains.Model.GetContactReachabilityStatusResponse 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-R53DContactReachabilityStatus.html&tocid=Get-R53DContactReachabilityStatus</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DDomainAuthCode</name> <description> <para>Invokes the RetrieveDomainAuthCode operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DDomainAuthCode</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. </para> </description> <syntax> <syntaxItem> <name>Get-R53DDomainAuthCode</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to get an authorization code for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to get an authorization code for. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.RetrieveDomainAuthCodeResponse) 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-R53DDomainAuthCode.html&tocid=Get-R53DDomainAuthCode</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DDomainDetail</name> <description> <para>Invokes the GetDomainDetail operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DDomainDetail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output. </para> </description> <syntax> <syntaxItem> <name>Get-R53DDomainDetail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to get detailed information about. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to get detailed information about. </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.Route53Domains.Model.GetDomainDetailResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53Domains.Model.GetDomainDetailResponse 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-R53DDomainDetail.html&tocid=Get-R53DDomainDetail</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DDomainList</name> <description> <para>Invokes the ListDomains operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DDomainList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-R53DDomainList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>MaxItem</name> <description> <para>Number of domains to be returned. Default: 20 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional domains. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element. Constraints: The marker must match the value specified in the previous request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional domains. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element. Constraints: The marker must match the value specified in the previous request. </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 (ByValue, )" position="1"> <name>MaxItem</name> <description> <para>Number of domains to be returned. Default: 20 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53Domains.Model.DomainSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DomainSummary objects. The service call response (type Amazon.Route53Domains.Model.ListDomainsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53DDomainList.html&tocid=Get-R53DDomainList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DDomainSuggestion</name> <description> <para>Invokes the GetDomainSuggestions operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DDomainSuggestion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces). </para> </description> <syntax> <syntaxItem> <name>Get-R53DDomainSuggestion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can Register with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OnlyAvailable</name> <description> <para>If <code>OnlyAvailable</code> is <code>true</code>, Amazon Route 53 returns only domain names that are available. If <code>OnlyAvailable</code> is <code>false</code>, Amazon Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call <code>checkDomainAvailability</code> for each suggestion. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SuggestionCount</name> <description> <para>The number of suggested domain names that you want Amazon Route 53 to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can Register with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. </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="False" position="Named"> <name>OnlyAvailable</name> <description> <para>If <code>OnlyAvailable</code> is <code>true</code>, Amazon Route 53 returns only domain names that are available. If <code>OnlyAvailable</code> is <code>false</code>, Amazon Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call <code>checkDomainAvailability</code> for each suggestion. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SuggestionCount</name> <description> <para>The number of suggested domain names that you want Amazon Route 53 to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53Domains.Model.DomainSuggestion</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DomainSuggestion objects. The service call response (type Amazon.Route53Domains.Model.GetDomainSuggestionsResponse) 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-R53DDomainSuggestion.html&tocid=Get-R53DDomainSuggestion</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DOperationDetail</name> <description> <para>Invokes the GetOperationDetail operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DOperationDetail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation returns the current status of an operation that is not completed. </para> </description> <syntax> <syntaxItem> <name>Get-R53DOperationDetail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>OperationId</name> <description> <para>The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>OperationId</name> <description> <para>The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request. </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.Route53Domains.Model.GetOperationDetailResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53Domains.Model.GetOperationDetailResponse 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-R53DOperationDetail.html&tocid=Get-R53DOperationDetail</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DOperationList</name> <description> <para>Invokes the ListOperations operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DOperationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation returns the operation IDs of operations that are not yet complete.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-R53DOperationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>MaxItem</name> <description> <para>Number of domains to be returned. Default: 20 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional operations. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional operations. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element. </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 (ByValue, )" position="1"> <name>MaxItem</name> <description> <para>Number of domains to be returned. Default: 20 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53Domains.Model.OperationSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of OperationSummary objects. The service call response (type Amazon.Route53Domains.Model.ListOperationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageMarker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-R53DOperationList.html&tocid=Get-R53DOperationList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Get-R53DTagsForDomain</name> <description> <para>Invokes the ListTagsForDomain operation against Amazon Route 53 Domains.</para> </description> <verb>Get</verb> <noun>R53DTagsForDomain</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation returns all of the tags that are associated with the specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. </para> </description> <syntax> <syntaxItem> <name>Get-R53DTagsForDomain</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The domain for which you want to get a list of tags. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The domain for which you want to get a list of tags. </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.Route53Domains.Model.Tag</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Tag objects. The service call response (type Amazon.Route53Domains.Model.ListTagsForDomainResponse) 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-R53DTagsForDomain.html&tocid=Get-R53DTagsForDomain</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Invoke-R53DDomainTransfer</name> <description> <para>Invokes the TransferDomain operation against Amazon Route 53 Domains.</para> </description> <verb>Invoke</verb> <noun>R53DDomainTransfer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi. For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html">Transferring Registration for a Domain to Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. <important><para> If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable. </para></important> If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email. </para> </description> <syntax> <syntaxItem> <name>Invoke-R53DDomainTransfer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to transfer to Amazon Route 53. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthCode</name> <description> <para>The authorization code for the domain. You get this value from the current registrar. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoRenew</name> <description> <para>Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged. Default: true </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DurationInYears</name> <description> <para>The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. Default: 1 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdnLangCode</name> <description> <para>Reserved for future use. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Nameserver</name> <description> <para>Contains details for the host and glue IP addresses. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.Nameserver[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectAdminContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectRegistrantContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectTechContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>AdminContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>AdminContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>AdminContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>AdminContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>AdminContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>AdminContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>AdminContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>AdminContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>AdminContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>AdminContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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="False" position="Named"> <name>AuthCode</name> <description> <para>The authorization code for the domain. You get this value from the current registrar. </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="False" position="Named"> <name>AutoRenew</name> <description> <para>Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged. Default: true </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to transfer to Amazon Route 53. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. </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="False" position="Named"> <name>DurationInYears</name> <description> <para>The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. Default: 1 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>IdnLangCode</name> <description> <para>Reserved for future use. </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="False" position="Named"> <name>Nameserver</name> <description> <para>Contains details for the host and glue IP addresses. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.Nameserver[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.Nameserver[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectAdminContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectRegistrantContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectTechContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>RegistrantContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>RegistrantContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>RegistrantContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>RegistrantContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>RegistrantContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>RegistrantContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>RegistrantContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>RegistrantContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>RegistrantContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>RegistrantContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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="False" position="Named"> <name>TechContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>TechContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>TechContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>TechContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>TechContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>TechContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>TechContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>TechContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>TechContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>TechContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>TechContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.TransferDomainResponse) 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=Invoke-R53DDomainTransfer.html&tocid=Invoke-R53DDomainTransfer</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Register-R53DDomain</name> <description> <para>Invokes the RegisterDomain operation against Amazon Route 53 Domains.</para> </description> <verb>Register</verb> <noun>R53DDomain</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters. When you register a domain, Amazon Route 53 does the following: - Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers. - Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration. - Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts. - If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email. - Charges your AWS account an amount based on the top-level domain. For more information, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>. </para> </description> <syntax> <syntaxItem> <name>Register-R53DDomain</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The domain name that you want to register. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoRenew</name> <description> <para>Indicates whether the domain will be automatically renewed (<code>true</code>) or not (<code>false</code>). Autorenewal only takes effect after the account is charged. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DurationInYears</name> <description> <para>The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can Register with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. Default: 1 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdnLangCode</name> <description> <para>Reserved for future use. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectAdminContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectRegistrantContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectTechContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>AdminContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>AdminContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>AdminContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>AdminContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>AdminContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>AdminContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>AdminContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>AdminContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>AdminContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>AdminContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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="False" position="Named"> <name>AutoRenew</name> <description> <para>Indicates whether the domain will be automatically renewed (<code>true</code>) or not (<code>false</code>). Autorenewal only takes effect after the account is charged. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The domain name that you want to register. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. </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="False" position="Named"> <name>DurationInYears</name> <description> <para>The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can Register with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. Default: 1 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>IdnLangCode</name> <description> <para>Reserved for future use. </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="False" position="Named"> <name>PrivacyProtectAdminContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectRegistrantContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivacyProtectTechContact</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>RegistrantContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>RegistrantContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>RegistrantContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>RegistrantContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>RegistrantContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>RegistrantContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>RegistrantContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>RegistrantContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>RegistrantContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>RegistrantContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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="False" position="Named"> <name>TechContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>TechContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>TechContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>TechContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>TechContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>TechContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>TechContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>TechContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>TechContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>TechContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>TechContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.RegisterDomainResponse) 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=Register-R53DDomain.html&tocid=Register-R53DDomain</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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-R53DTagsForDomain</name> <description> <para>Invokes the DeleteTagsForDomain operation against Amazon Route 53 Domains.</para> </description> <verb>Remove</verb> <noun>R53DTagsForDomain</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. </para> </description> <syntax> <syntaxItem> <name>Remove-R53DTagsForDomain</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The domain for which you want to delete one or more tags. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagsToDelete</name> <description> <para>A list of tag keys to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The domain for which you want to delete one or more tags. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>TagsToDelete</name> <description> <para>A list of tag keys to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DomainName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53Domains.Model.DeleteTagsForDomainResponse) 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-R53DTagsForDomain.html&tocid=Remove-R53DTagsForDomain</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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-R53DContactReachabilityEmail</name> <description> <para>Invokes the ResendContactReachabilityEmail operation against Amazon Route 53 Domains.</para> </description> <verb>Send</verb> <noun>R53DContactReachabilityEmail</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact. </para> </description> <syntax> <syntaxItem> <name>Send-R53DContactReachabilityEmail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Route53Domains.Model.ResendContactReachabilityEmailResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Route53Domains.Model.ResendContactReachabilityEmailResponse 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=Send-R53DContactReachabilityEmail.html&tocid=Send-R53DContactReachabilityEmail</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Test-R53DDomainAvailability</name> <description> <para>Invokes the CheckDomainAvailability operation against Amazon Route 53 Domains.</para> </description> <verb>Test</verb> <noun>R53DDomainAvailability</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. </para> </description> <syntax> <syntaxItem> <name>Test-R53DDomainAvailability</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to get availability for. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IdnLangCode</name> <description> <para>Reserved for future use. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to get availability for. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. </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="False" position="Named"> <name>IdnLangCode</name> <description> <para>Reserved for future use. </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.Route53Domains.DomainAvailability</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DomainAvailability object. The service call response (type Amazon.Route53Domains.Model.CheckDomainAvailabilityResponse) 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=Test-R53DDomainAvailability.html&tocid=Test-R53DDomainAvailability</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Test-R53DDomainTransferability</name> <description> <para>Invokes the CheckDomainTransferability operation against Amazon Route 53 Domains.</para> </description> <verb>Test</verb> <noun>R53DDomainTransferability</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Checks whether a domain name can be transferred to Amazon Route 53. </para> </description> <syntax> <syntaxItem> <name>Test-R53DDomainTransferability</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to transfer to Amazon Route 53. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthCode</name> <description> <para>If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, the code that you got from the current registrar for the domain. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AuthCode</name> <description> <para>If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, the code that you got from the current registrar for the domain. </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 (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to transfer to Amazon Route 53. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported. </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.Route53Domains.Model.DomainTransferability</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DomainTransferability object. The service call response (type Amazon.Route53Domains.Model.CheckDomainTransferabilityResponse) 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=Test-R53DDomainTransferability.html&tocid=Test-R53DDomainTransferability</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53DDomainContact</name> <description> <para>Invokes the UpdateDomainContact operation against Amazon Route 53 Domains.</para> </description> <verb>Update</verb> <noun>R53DDomainContact</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update. If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </description> <syntax> <syntaxItem> <name>Update-R53DDomainContact</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to update contact information for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_AddressLine1</name> <description> <para>First line of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_City</name> <description> <para>The city of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Email</name> <description> <para>Email address of the contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_FirstName</name> <description> <para>First name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_LastName</name> <description> <para>Last name of contact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_State</name> <description> <para>The state or province of the contact's city. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>AdminContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>AdminContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>AdminContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>AdminContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>AdminContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>AdminContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>AdminContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>AdminContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>AdminContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>AdminContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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 (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to update contact information for. </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="False" 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="False" position="Named"> <name>RegistrantContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>RegistrantContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>RegistrantContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>RegistrantContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>RegistrantContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>RegistrantContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>RegistrantContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>RegistrantContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>RegistrantContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>RegistrantContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>RegistrantContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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="False" position="Named"> <name>TechContact_AddressLine1</name> <description> <para>First line of the contact's address. </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="False" position="Named"> <name>TechContact_AddressLine2</name> <description> <para>Second line of contact's address, if any. </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="False" position="Named"> <name>TechContact_City</name> <description> <para>The city of the contact's address. </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="False" position="Named"> <name>TechContact_ContactType</name> <description> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.ContactType</parameterValue> <type> <name>Amazon.Route53Domains.ContactType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_CountryCode</name> <description> <para>Code for the country of the contact's address. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.CountryCode</parameterValue> <type> <name>Amazon.Route53Domains.CountryCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Email</name> <description> <para>Email address of the contact. </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="False" position="Named"> <name>TechContact_ExtraParam</name> <description> <para>A list of name-value pairs for parameters required by certain top-level domains. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.ExtraParam[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.ExtraParam[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechContact_Fax</name> <description> <para>Fax number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>TechContact_FirstName</name> <description> <para>First name of contact. </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="False" position="Named"> <name>TechContact_LastName</name> <description> <para>Last name of contact. </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="False" position="Named"> <name>TechContact_OrganizationName</name> <description> <para>Name of the organization for contact types other than <code>PERSON</code>. </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="False" position="Named"> <name>TechContact_PhoneNumber</name> <description> <para>The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>. </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="False" position="Named"> <name>TechContact_State</name> <description> <para>The state or province of the contact's city. </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="False" position="Named"> <name>TechContact_ZipCode</name> <description> <para>The zip or postal code of the contact's address. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.UpdateDomainContactResponse) 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=Update-R53DDomainContact.html&tocid=Update-R53DDomainContact</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53DDomainContactPrivacy</name> <description> <para>Invokes the UpdateDomainContactPrivacy operation against Amazon Route 53 Domains.</para> </description> <verb>Update</verb> <noun>R53DDomainContactPrivacy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the <a href="http://www.gandi.net/domain/whois/?currency=USD&amp;amp;lang=en">Gandi privacy features</a>. This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with <a>GetOperationDetail</a> to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </description> <syntax> <syntaxItem> <name>Update-R53DDomainContactPrivacy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to update the privacy setting for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminPrivacy</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegistrantPrivacy</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechPrivacy</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdminPrivacy</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to update the privacy setting for. </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="False" 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="False" position="Named"> <name>RegistrantPrivacy</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TechPrivacy</name> <description> <para>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.UpdateDomainContactPrivacyResponse) 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=Update-R53DDomainContactPrivacy.html&tocid=Update-R53DDomainContactPrivacy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53DDomainNameserver</name> <description> <para>Invokes the UpdateDomainNameservers operation against Amazon Route 53 Domains.</para> </description> <verb>Update</verb> <noun>R53DDomainNameserver</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </description> <syntax> <syntaxItem> <name>Update-R53DDomainNameserver</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to change name servers for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FIAuthKey</name> <description> <para>The authorization key for .fi domains </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Nameserver</name> <description> <para>A list of new name servers for the domain. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.Nameserver[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to change name servers for. </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="False" position="Named"> <name>FIAuthKey</name> <description> <para>The authorization key for .fi domains </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="False" 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="False" position="Named"> <name>Nameserver</name> <description> <para>A list of new name servers for the domain. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.Nameserver[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.Nameserver[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.UpdateDomainNameserversResponse) 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=Update-R53DDomainNameserver.html&tocid=Update-R53DDomainNameserver</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53DDomainRenewal</name> <description> <para>Invokes the RenewDomain operation against Amazon Route 53 Domains.</para> </description> <verb>Update</verb> <noun>R53DDomainRenewal</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account. We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html">Renewing Registration for a Domain</a> in the Amazon Route 53 Developer Guide. </para> </description> <syntax> <syntaxItem> <name>Update-R53DDomainRenewal</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to renew. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CurrentExpiryYear</name> <description> <para>The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DurationInYear</name> <description> <para>The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can Register with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. Default: 1 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CurrentExpiryYear</name> <description> <para>The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The name of the domain that you want to renew. </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="False" position="Named"> <name>DurationInYear</name> <description> <para>The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can Register with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. Default: 1 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.Route53Domains.Model.RenewDomainResponse) 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=Update-R53DDomainRenewal.html&tocid=Update-R53DDomainRenewal</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Update-R53DTagsForDomain</name> <description> <para>Invokes the UpdateTagsForDomain operation against Amazon Route 53 Domains.</para> </description> <verb>Update</verb> <noun>R53DTagsForDomain</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations. </para> </description> <syntax> <syntaxItem> <name>Update-R53DTagsForDomain</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The domain for which you want to add or update tags. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagsToUpdate</name> <description> <para>A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DomainName</name> <description> <para>The domain for which you want to add or update tags. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>TagsToUpdate</name> <description> <para>A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Route53Domains.Model.Tag[]</parameterValue> <type> <name>Amazon.Route53Domains.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DomainName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Route53Domains.Model.UpdateTagsForDomainResponse) 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=Update-R53DTagsForDomain.html&tocid=Update-R53DTagsForDomain</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/elastictranscoder/latest/developerguide/introduction.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/Route53/latest/APIReference/</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>Add-RGTResourceTag</name> <description> <para>Invokes the TagResources operation against AWS Resource Groups Tagging API.</para> </description> <verb>Add</verb> <noun>RGTResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Applies one or more tags to the specified resources. Note the following: - Not all resources can have tags. For a list of resources that support tagging, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/supported-resources.html">Supported Resources</a> in the <i>AWS Resource Groups and Tag Editor User Guide</i>. - Each resource can have up to 50 tags. For other limits, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions">Tag Restrictions</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. - You can only tag resources that are located in the specified region for the AWS account. - To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html">Obtaining Permissions for Tagging</a> in the <i>AWS Resource Groups and Tag Editor User Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Add-RGTResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceARNList</name> <description> <para>A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>The tags that you want to add to the specified resources. A tag consists of a key and a value that you define. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>ResourceARNList</name> <description> <para>A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </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="False" position="Named"> <name>Tag</name> <description> <para>The tags that you want to add to the specified resources. A tag consists of a key and a value that you define. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.TagResourcesResponse) 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=Add-RGTResourceTag.html&tocid=Add-RGTResourceTag</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> $arn1 = "arn:aws:s3:::mybucket" PS C:\> $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" PS C:\> Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" } </code><remarks><para>Description</para><para>-----------</para><para>This example adds the tag keys "stage" and "version" with values "beta" and "preprod_test" to an Amazon S3 bucket and an Amazon DynamoDB table. A single call is made to the service to apply the tags.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> $arn1 = "arn:aws:s3:::mybucket" PS C:\> $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" PS C:\> $arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" } </code><remarks><para>Description</para><para>-----------</para><para>This example adds the specified tags and values to an Amazon S3 bucket and an Amazon DynamoDB table. Two calls are made to the service, one for each resource ARN piped into the cmdlet.</para><para /><para /></remarks> </example> </examples> </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>Get-RGTResource</name> <description> <para>Invokes the GetResources operation against AWS Resource Groups Tagging API.</para> </description> <verb>Get</verb> <noun>RGTResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as <i>filters</i>. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RGTResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceTypeFilter</name> <description> <para>The constraints on the resources that you want returned. The format of each resource type is <code>service[:resourceType]</code>. For example, specifying a resource type of <code>ec2</code> returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type of <code>ec2:instance</code> returns only EC2 instances. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the <i>AWS General Reference</i> for the following: - For a list of service name strings, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces">AWS Service Namespaces</a>. - For resource type strings, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax">Example ARNs</a>. - For more information about ARNs, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourcesPerPage</name> <description> <para>A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagFilter</name> <description> <para>A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values. If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter. If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroupsTaggingAPI.Model.TagFilter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagsPerPage</name> <description> <para>A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair). <code>GetResources</code> does not split a resource and its associated tags across pages. If the specified <code>TagsPerPage</code> would cause such a break, a <code>PaginationToken</code> is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a <code>TagsPerPage</code> of <code>100</code> and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags. You can set <code>TagsPerPage</code> to a minimum of 100 items and the maximum of 500 items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a <code>PaginationToken</code>, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a <code>PaginationToken</code>, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>ResourcesPerPage</name> <description> <para>A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceTypeFilter</name> <description> <para>The constraints on the resources that you want returned. The format of each resource type is <code>service[:resourceType]</code>. For example, specifying a resource type of <code>ec2</code> returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type of <code>ec2:instance</code> returns only EC2 instances. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the <i>AWS General Reference</i> for the following: - For a list of service name strings, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces">AWS Service Namespaces</a>. - For resource type strings, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax">Example ARNs</a>. - For more information about ARNs, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </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="False" position="Named"> <name>TagFilter</name> <description> <para>A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values. If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter. If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters. </para> </description> <parameterValue required="true" variableLength="false">Amazon.ResourceGroupsTaggingAPI.Model.TagFilter[]</parameterValue> <type> <name>Amazon.ResourceGroupsTaggingAPI.Model.TagFilter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagsPerPage</name> <description> <para>A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair). <code>GetResources</code> does not split a resource and its associated tags across pages. If the specified <code>TagsPerPage</code> would cause such a break, a <code>PaginationToken</code> is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a <code>TagsPerPage</code> of <code>100</code> and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags. You can set <code>TagsPerPage</code> to a minimum of 100 items and the maximum of 500 items. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.ResourceGroupsTaggingAPI.Model.ResourceTagMapping</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ResourceTagMapping objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.GetResourcesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: PaginationToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RGTResource.html&tocid=Get-RGTResource</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> Get-RGTResource ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::mybucket {stage, version, othertag} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources in a region and the tag keys associated with the resource. If no -Region parameter is supplied to the cmdlet it will attempt to infer region from the shell or EC2 instance metadata.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> Get-RGTResource -ResourceType "s3" ResourceARN Tags ----------- ---- arn:aws:s3:::mybucket {stage, version, othertag} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources of the specified type in a region. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN).</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 3 --------------------------</title><code> PS C:\> "dynamodb","s3" | Get-RGTResource ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} arn:aws:s3:::mybucket {stage, version, othertag} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources of the specified type in a region. Note that when the resource types are piped into the cmdlet, one call to the service is made for each supplied resource type.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 4 --------------------------</title><code> PS C:\> Get-RGTResource -TagFilter @{ Key="stage" } ResourceARN Tags ----------- ---- arn:aws:s3:::mybucket {stage, version, othertag} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources that match the specified filter.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 5 --------------------------</title><code> PS C:\> Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb" ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources that match the specified filter and resource type.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 6 --------------------------</title><code> PS C:\> Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") } ResourceARN Tags ----------- ---- arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version} </code><remarks><para>Description</para><para>-----------</para><para>Returns all the tagged resources that match the specified filter.</para><para /><para /></remarks> </example> </examples> </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>Get-RGTTagKey</name> <description> <para>Invokes the GetTagKeys operation against AWS Resource Groups Tagging API.</para> </description> <verb>Get</verb> <noun>RGTTagKey</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all tag keys in the specified region for the AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RGTTagKey</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.GetTagKeysResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: PaginationToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RGTTagKey.html&tocid=Get-RGTTagKey</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> Get-RGTTagKey -region us-west-2 version stage </code><remarks><para>Description</para><para>-----------</para><para>Returns all tag keys in the specified region. If the -Region parameter is not specified the cmdlet will attempt to infer the region from the default shell region or EC2 instance metadata. Note that the tag keys are not returned in any specific order.</para><para /><para /></remarks> </example> </examples> </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>Get-RGTTagValue</name> <description> <para>Invokes the GetTagValues operation against AWS Resource Groups Tagging API.</para> </description> <verb>Get</verb> <noun>RGTTagValue</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns all tag values for the specified key in the specified region for the AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RGTTagValue</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>The key for which you want to list all existing values in the specified region for the AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Key</name> <description> <para>The key for which you want to list all existing values in the specified region for the AWS account. </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="False" position="Named"> <name>PaginationToken</name> <description> <para>A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.GetTagValuesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: PaginationToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RGTTagValue.html&tocid=Get-RGTTagValue</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> Get-RGTTagValue -Key "stage" -Region us-west-2 beta </code><remarks><para>Description</para><para>-----------</para><para>Returns the value for the specified tag in a region. If the -Region parameter is not specified the cmdlet will attempt to infer the region from the default shell region or EC2 instance metadata.</para><para /><para /></remarks> </example> </examples> </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-RGTResourceTag</name> <description> <para>Invokes the UntagResources operation against AWS Resource Groups Tagging API.</para> </description> <verb>Remove</verb> <noun>RGTResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: - To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see <a href="http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html">Obtaining Permissions for Tagging</a> in the <i>AWS Resource Groups and Tag Editor User Guide</i>. - You can only tag resources that are located in the specified region for the AWS account. </para> </description> <syntax> <syntaxItem> <name>Remove-RGTResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceARNList</name> <description> <para>A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A list of the tag keys that you want to remove from the specified resources. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>ResourceARNList</name> <description> <para>A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </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="False" position="Named"> <name>TagKey</name> <description> <para>A list of the tag keys that you want to remove from the specified resources. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.ResourceGroupsTaggingAPI.Model.UntagResourcesResponse) 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=Remove-RGTResourceTag.html&tocid=Remove-RGTResourceTag</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> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code> PS C:\> $arn1 = "arn:aws:s3:::mybucket" PS C:\> $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" PS C:\> Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version" </code><remarks><para>Description</para><para>-----------</para><para>Removes the tag keys "stage" and "version", and the associated values, from an Amazon S3 bucket and an Amazon DynamoDB table. A single call is made to the service to remove the tags. Before the tags are removed the cmdlet will prompt for confirmation. To bypass confirmation add the -Force parameter.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code> PS C:\> $arn1 = "arn:aws:s3:::mybucket" PS C:\> $arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable" PS C:\> $arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version" </code><remarks><para>Description</para><para>-----------</para><para>Removes the tag keys "stage" and "version", and the associated values, from an Amazon S3 bucket and an Amazon DynamoDB table. Two calls are made to the service, one for each resource ARN piped into the cmdlet. Before each call the cmdlet will prompt for confirmation. To bypass confirmation add the -Force parameter.</para><para /><para /></remarks> </example> </examples> </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>Add-REKDetectedFacesToCollection</name> <description> <para>Invokes the IndexFaces operation against Amazon Rekognition.</para> </description> <verb>Add</verb> <noun>REKDetectedFacesToCollection</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Detects faces in the input image and adds them to the specified collection. Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations. If you provide the optional <code>externalImageID</code> for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image. If you request all facial attributes (using the <code>detectionAttributes</code> parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata. For an example, see <a>example2</a>. This operation requires permissions to perform the <code>rekognition:IndexFaces</code> action. </para> </description> <syntax> <syntaxItem> <name>Add-REKDetectedFacesToCollection</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>The ID of an existing collection to which you want to add the faces that are detected in the input images. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DetectionAttribute</name> <description> <para>An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code> and <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial attributes are returned but the operation will take longer to complete. If you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ExternalImageId</name> <description> <para>ID you want to assign to all the faces detected in the image. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>The ID of an existing collection to which you want to add the faces that are detected in the input images. </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="False" position="Named"> <name>DetectionAttribute</name> <description> <para>An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code> and <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial attributes are returned but the operation will take longer to complete. If you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </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>ExternalImageId</name> <description> <para>ID you want to assign to all the faces detected in the image. </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="False" 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="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </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="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </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="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </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="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </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.Rekognition.Model.IndexFacesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.IndexFacesResponse 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=Add-REKDetectedFacesToCollection.html&tocid=Add-REKDetectedFacesToCollection</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>Compare-REKFace</name> <description> <para>Invokes the CompareFaces operation against Amazon Rekognition.</para> </description> <verb>Compare</verb> <noun>REKFace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Compares a face in the <i>source</i> input image with each face detected in the <i>target</i> input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the <code>SimilarityThreshold</code> parameter. <code>CompareFaces</code> also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see <a>get-started-exercise-compare-faces</a>. This operation requires permissions to perform the <code>rekognition:CompareFaces</code> action. </para> </description> <syntax> <syntaxItem> <name>Compare-REKFace</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceImageBucket</name> <description> <para>Name of the S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetImageBucket</name> <description> <para>Name of the S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceImageName</name> <description> <para>S3 object key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetImageName</name> <description> <para>S3 object key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SimilarityThreshold</name> <description> <para>The minimum level of confidence in the face matches that a match must meet to be included in the <code>FaceMatches</code> array. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>SimilarityThreshold</name> <description> <para>The minimum level of confidence in the face matches that a match must meet to be included in the <code>FaceMatches</code> array. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> <type> <name>System.Single</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceImageBucket</name> <description> <para>Name of the S3 bucket. </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="False" position="Named"> <name>SourceImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </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="False" position="Named"> <name>SourceImageName</name> <description> <para>S3 object key name. </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="False" position="Named"> <name>SourceImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </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="False" position="Named"> <name>TargetImageBucket</name> <description> <para>Name of the S3 bucket. </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="False" position="Named"> <name>TargetImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </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="False" position="Named"> <name>TargetImageName</name> <description> <para>S3 object key name. </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="False" position="Named"> <name>TargetImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </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.Rekognition.Model.CompareFacesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.CompareFacesResponse 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=Compare-REKFace.html&tocid=Compare-REKFace</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>Find-REKCelebrity</name> <description> <para>Invokes the RecognizeCelebrities operation against Amazon Rekognition.</para> </description> <verb>Find</verb> <noun>REKCelebrity</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of celebrities recognized in the input image. The image is passed either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPEG formatted file. For more information, see <a>celebrity-recognition</a>. <code>RecognizeCelebrities</code> returns the 15 largest faces in the image. It lists recognized celebrities in the <code>CelebrityFaces</code> list and unrecognized faces in the <code>UnrecognizedFaces</code> list. The operation doesn't return celebrities whose face sizes are smaller than the largest 15 faces in the image. For each celebrity recognized, the API returns a <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity name, ID, URL links to additional information, match confidence, and a <code>ComparedFace</code> object that you can use to locate the celebrity's face on the image. Rekognition does not retain information about which images a celebrity has been recognized in. Your application must store this information and use the <code>Celebrity</code> ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by <code>RecognizeCelebrities</code>, you will need the ID to identify the celebrity in a call to the operation. For an example, see <a>recognize-celebrities-tutorial</a>. This operation requires permissions to perform the <code>rekognition:RecognizeCelebrities</code> operation. </para> </description> <syntax> <syntaxItem> <name>Find-REKCelebrity</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </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="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </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="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </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="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </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.Rekognition.Model.RecognizeCelebritiesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.RecognizeCelebritiesResponse 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=Find-REKCelebrity.html&tocid=Find-REKCelebrity</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>Find-REKFace</name> <description> <para>Invokes the DetectFaces operation against Amazon Rekognition.</para> </description> <verb>Find</verb> <noun>REKFace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Detects faces within an image (JPEG or PNG) that is provided as input. For each face detected, the operation returns face details including a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, etc. The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm may not detect the faces or might detect faces with lower confidence. This is a stateless API operation. That is, the operation does not persist any data. For an example, see <a>get-started-exercise-detect-faces</a>. This operation requires permissions to perform the <code>rekognition:DetectFaces</code> action. </para> </description> <syntax> <syntaxItem> <name>Find-REKFace</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code> and <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial attributes are returned but the operation will take longer to complete. If you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code> and <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial attributes are returned but the operation will take longer to complete. If you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </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="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </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="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </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="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </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="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </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.Rekognition.Model.DetectFacesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.DetectFacesResponse 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=Find-REKFace.html&tocid=Find-REKFace</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>Find-REKLabel</name> <description> <para>Invokes the DetectLabels operation against Amazon Rekognition.</para> </description> <verb>Find</verb> <noun>REKLabel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Detects instances of real-world labels within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see <a>get-started-exercise-detect-labels</a>. For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object. <code>{Name: lighthouse, Confidence: 98.4629}</code> <code>{Name: rock,Confidence: 79.2097}</code> <code> {Name: sea,Confidence: 75.061}</code> In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. <code>{Name: flower,Confidence: 99.0562}</code> <code>{Name: plant,Confidence: 99.0562}</code> <code>{Name: tulip,Confidence: 99.0562}</code> In this example, the detection algorithm more precisely identifies the flower as a tulip. You can provide the input image as an S3 object or as base64-encoded bytes. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify <code>MinConfidence</code> to control the confidence threshold for the labels returned. The default is 50%. You can also add the <code>MaxLabels</code> parameter to limit the number of labels returned. If the object detected is a person, the operation doesn't provide the same facial details that the <a>DetectFaces</a> operation provides. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the <code>rekognition:DetectLabels</code> action. </para> </description> <syntax> <syntaxItem> <name>Find-REKLabel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxLabel</name> <description> <para>Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MinConfidence</name> <description> <para>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value. If <code>MinConfidence</code> is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </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="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </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="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </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="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </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="False" position="Named"> <name>MaxLabel</name> <description> <para>Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MinConfidence</name> <description> <para>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value. If <code>MinConfidence</code> is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> <type> <name>System.Single</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Rekognition.Model.DetectLabelsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.DetectLabelsResponse 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=Find-REKLabel.html&tocid=Find-REKLabel</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>Find-REKModerationLabel</name> <description> <para>Invokes the DetectModerationLabels operation against Amazon Rekognition.</para> </description> <verb>Find</verb> <noun>REKModerationLabel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Detects explicit or suggestive adult content in a specified JPEG or PNG format image. Use <code>DetectModerationLabels</code> to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content. To filter images, use the labels returned by <code>DetectModerationLabels</code> to determine which types of content are appropriate. For information about moderation labels, see <a>image-moderation</a>. </para> </description> <syntax> <syntaxItem> <name>Find-REKModerationLabel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Object_Bucket</name> <description> <para>Name of the S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Image_Byte</name> <description> <para>Blob of image bytes up to 5 MBs. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MinConfidence</name> <description> <para>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value. If you don't specify <code>MinConfidence</code>, the operation returns labels with confidence values greater than or equal to 50 percent. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Object_Name</name> <description> <para>S3 object key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Object_Version</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Image_Byte</name> <description> <para>Blob of image bytes up to 5 MBs. </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="False" position="Named"> <name>MinConfidence</name> <description> <para>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value. If you don't specify <code>MinConfidence</code>, the operation returns labels with confidence values greater than or equal to 50 percent. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> <type> <name>System.Single</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Object_Bucket</name> <description> <para>Name of the S3 bucket. </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="False" position="Named"> <name>S3Object_Name</name> <description> <para>S3 object key name. </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="False" position="Named"> <name>S3Object_Version</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </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.Rekognition.Model.ModerationLabel</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ModerationLabel objects. The service call response (type Amazon.Rekognition.Model.DetectModerationLabelsResponse) 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=Find-REKModerationLabel.html&tocid=Find-REKModerationLabel</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>Get-REKCelebrityInfo</name> <description> <para>Invokes the GetCelebrityInfo operation against Amazon Rekognition.</para> </description> <verb>Get</verb> <noun>REKCelebrityInfo</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets the name and additional information about a celebrity based on his or her Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see <a>celebrity-recognition</a>. This operation requires permissions to perform the <code>rekognition:GetCelebrityInfo</code> action. </para> </description> <syntax> <syntaxItem> <name>Get-REKCelebrityInfo</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The ID for the celebrity. You get the celebrity ID from a call to the operation, which recognizes celebrities in an image. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Id</name> <description> <para>The ID for the celebrity. You get the celebrity ID from a call to the operation, which recognizes celebrities in an image. </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.Rekognition.Model.GetCelebrityInfoResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.GetCelebrityInfoResponse 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-REKCelebrityInfo.html&tocid=Get-REKCelebrityInfo</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>Get-REKCollectionIdList</name> <description> <para>Invokes the ListCollections operation against Amazon Rekognition.</para> </description> <verb>Get</verb> <noun>REKCollectionIdList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns list of collection IDs in your account. If the result is truncated, the response also provides a <code>NextToken</code> that you can use in the subsequent request to fetch the next set of collection IDs. For an example, see <a>example1</a>. This operation requires permissions to perform the <code>rekognition:ListCollections</code> action. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-REKCollectionIdList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Maximum number of collection IDs to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token from the previous response. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Maximum number of collection IDs to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token from the previous response. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.Rekognition.Model.ListCollectionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-REKCollectionIdList.html&tocid=Get-REKCollectionIdList</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>Get-REKFaceList</name> <description> <para>Invokes the ListFaces operation against Amazon Rekognition.</para> </description> <verb>Get</verb> <noun>REKFaceList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see <a>example3</a>. This operation requires permissions to perform the <code>rekognition:ListFaces</code> action. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-REKFaceList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID of the collection from which to list the faces. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Maximum number of faces to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID of the collection from which to list the faces. </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="False" position="Named"> <name>MaxResult</name> <description> <para>Maximum number of faces to return. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Rekognition.Model.Face</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Face objects. The service call response (type Amazon.Rekognition.Model.ListFacesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-REKFaceList.html&tocid=Get-REKFaceList</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>New-REKCollection</name> <description> <para>Invokes the CreateCollection operation against Amazon Rekognition.</para> </description> <verb>New</verb> <noun>REKCollection</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a collection in an AWS Region. You can add faces to the collection using the operation. For example, you might create collections, one for each of your application users. A user can then index faces using the <code>IndexFaces</code> operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. Collection names are case-sensitive. For an example, see <a>example1</a>. This operation requires permissions to perform the <code>rekognition:CreateCollection</code> action. </para> </description> <syntax> <syntaxItem> <name>New-REKCollection</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID for the collection that you are creating. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID for the collection that you are creating. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Rekognition.Model.CreateCollectionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.CreateCollectionResponse 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=New-REKCollection.html&tocid=New-REKCollection</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-REKCollection</name> <description> <para>Invokes the DeleteCollection operation against Amazon Rekognition.</para> </description> <verb>Remove</verb> <noun>REKCollection</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see <a>example1</a>. This operation requires permissions to perform the <code>rekognition:DeleteCollection</code> action. </para> </description> <syntax> <syntaxItem> <name>Remove-REKCollection</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID of the collection to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID of the collection to delete. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.Int32</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Int32 object. The service call response (type Amazon.Rekognition.Model.DeleteCollectionResponse) 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=Remove-REKCollection.html&tocid=Remove-REKCollection</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-REKFace</name> <description> <para>Invokes the DeleteFaces operation against Amazon Rekognition.</para> </description> <verb>Remove</verb> <noun>REKFace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. This operation requires permissions to perform the <code>rekognition:DeleteFaces</code> action. </para> </description> <syntax> <syntaxItem> <name>Remove-REKFace</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CollectionId</name> <description> <para>Collection from which to remove the specific faces. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FaceId</name> <description> <para>An array of face IDs to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CollectionId</name> <description> <para>Collection from which to remove the specific faces. </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>FaceId</name> <description> <para>An array of face IDs to delete. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.Rekognition.Model.DeleteFacesResponse) 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=Remove-REKFace.html&tocid=Remove-REKFace</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>Search-REKFace</name> <description> <para>Invokes the SearchFaces operation against Amazon Rekognition.</para> </description> <verb>Search</verb> <noun>REKFace</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the <a>IndexFaces</a> operation. The operation compares the features of the input face with faces in the specified collection. You can also search faces without indexing faces by using the <code>SearchFacesByImage</code> operation. The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a <code>confidence</code> value for each face match, indicating the confidence that the specific face matches the input face. For an example, see <a>example3</a>. This operation requires permissions to perform the <code>rekognition:SearchFaces</code> action. </para> </description> <syntax> <syntaxItem> <name>Search-REKFace</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID of the collection the face belongs to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FaceId</name> <description> <para>ID of a face to find matches for in the collection. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FaceMatchThreshold</name> <description> <para>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxFace</name> <description> <para>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID of the collection the face belongs to. </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>FaceId</name> <description> <para>ID of a face to find matches for in the collection. </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="False" position="Named"> <name>FaceMatchThreshold</name> <description> <para>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> <type> <name>System.Single</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>MaxFace</name> <description> <para>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Rekognition.Model.SearchFacesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.SearchFacesResponse 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=Search-REKFace.html&tocid=Search-REKFace</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>Search-REKFacesByImage</name> <description> <para>Invokes the SearchFacesByImage operation against Amazon Rekognition.</para> </description> <verb>Search</verb> <noun>REKFacesByImage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation. You can also call the <code>DetectFaces</code> operation and use the bounding boxes in the response to make face crops, which then you can pass in to the <code>SearchFacesByImage</code> operation. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a <code>similarity</code> indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, see <a>example3</a>. This operation requires permissions to perform the <code>rekognition:SearchFacesByImage</code> action. </para> </description> <syntax> <syntaxItem> <name>Search-REKFacesByImage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID of the collection to search. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </para> </description> <parameterValue required="true" variableLength="false">System.Byte[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FaceMatchThreshold</name> <description> <para>(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxFace</name> <description> <para>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CollectionId</name> <description> <para>ID of the collection to search. </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="False" position="Named"> <name>FaceMatchThreshold</name> <description> <para>(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. </para> </description> <parameterValue required="true" variableLength="false">System.Single</parameterValue> <type> <name>System.Single</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>ImageBucket</name> <description> <para>Name of the S3 bucket. </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="False" position="Named"> <name>ImageContent</name> <description> <para>Blob of image bytes up to 5 MBs. </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="False" position="Named"> <name>ImageName</name> <description> <para>S3 object key name. </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="False" position="Named"> <name>ImageVersion</name> <description> <para>If the bucket is versioning enabled, you can specify the object version. </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="False" position="Named"> <name>MaxFace</name> <description> <para>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Rekognition.Model.SearchFacesByImageResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Rekognition.Model.SearchFacesByImageResponse 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=Search-REKFacesByImage.html&tocid=Search-REKFacesByImage</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>Approve-RSClusterSecurityGroupIngress</name> <description> <para>Invokes the AuthorizeClusterSecurityGroupIngress operation against Amazon Redshift.</para> </description> <verb>Approve</verb> <noun>RSClusterSecurityGroupIngress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an Amazon EC2 security group, specify <i>EC2SecurityGroupName</i> and <i>EC2SecurityGroupOwnerId</i>. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS region. If you authorize access to a CIDR/IP address range, specify <i>CIDRIP</i>. For an overview of CIDR blocks, see the Wikipedia article on <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Working with Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Approve-RSClusterSecurityGroupIngress</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name of the security group to which the ingress rule is added. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>CIDRIP</name> <description> <para>The IP range to be added the Amazon Redshift security group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>EC2SecurityGroupName</name> <description> <para>The EC2 security group to be added the Amazon Redshift security group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <name>EC2SecurityGroupOwnerId</name> <description> <para>The AWS account number of the owner of the security group specified by the <i>EC2SecurityGroupName</i> parameter. The AWS Access Key ID is not an acceptable value. Example: <code>111122223333</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>CIDRIP</name> <description> <para>The IP range to be added the Amazon Redshift security group. </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 (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name of the security group to which the ingress rule is added. </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="3"> <name>EC2SecurityGroupName</name> <description> <para>The EC2 security group to be added the Amazon Redshift security group. </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="4"> <name>EC2SecurityGroupOwnerId</name> <description> <para>The AWS account number of the owner of the security group specified by the <i>EC2SecurityGroupName</i> parameter. The AWS Access Key ID is not an acceptable value. Example: <code>111122223333</code> </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.ClusterSecurityGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ClusterSecurityGroup object. The service call response (type Amazon.Redshift.Model.AuthorizeClusterSecurityGroupIngressResponse) 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=Approve-RSClusterSecurityGroupIngress.html&tocid=Approve-RSClusterSecurityGroupIngress</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Approve-RSSnapshotAccess</name> <description> <para>Invokes the AuthorizeSnapshotAccess operation against Amazon Redshift.</para> </description> <verb>Approve</verb> <noun>RSSnapshotAccess</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Authorizes the specified AWS customer account to restore the specified snapshot. For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Approve-RSSnapshotAccess</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SnapshotIdentifier</name> <description> <para>The identifier of the snapshot the account is authorized to restore. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AccountWithRestoreAccess</name> <description> <para>The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotClusterIdentifier</name> <description> <para>The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AccountWithRestoreAccess</name> <description> <para>The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support. </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="False" 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="False" position="Named"> <name>SnapshotClusterIdentifier</name> <description> <para>The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </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 (ByValue, ByPropertyName)" position="1"> <name>SnapshotIdentifier</name> <description> <para>The identifier of the snapshot the account is authorized to restore. </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.Redshift.Model.Snapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Snapshot object. The service call response (type Amazon.Redshift.Model.AuthorizeSnapshotAccessResponse) 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=Approve-RSSnapshotAccess.html&tocid=Approve-RSSnapshotAccess</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Copy-RSClusterSnapshot</name> <description> <para>Invokes the CopyClusterSnapshot operation against Amazon Redshift.</para> </description> <verb>Copy</verb> <noun>RSClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Copy-RSClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceSnapshotIdentifier</name> <description> <para>The identifier for the source snapshot. Constraints: - Must be the identifier for a valid automated snapshot whose state is <code>available</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetSnapshotIdentifier</name> <description> <para>The identifier given to the new manual snapshot. Constraints: - Cannot be null, empty, or blank. - Must contain from 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for the AWS account that is making the request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceSnapshotClusterIdentifier</name> <description> <para>The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: - Must be the identifier for a valid cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>SourceSnapshotClusterIdentifier</name> <description> <para>The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: - Must be the identifier for a valid cluster. </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 (ByValue, )" position="1"> <name>SourceSnapshotIdentifier</name> <description> <para>The identifier for the source snapshot. Constraints: - Must be the identifier for a valid automated snapshot whose state is <code>available</code>. </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="False" position="2"> <name>TargetSnapshotIdentifier</name> <description> <para>The identifier given to the new manual snapshot. Constraints: - Cannot be null, empty, or blank. - Must contain from 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for the AWS account that is making the request. </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.Redshift.Model.Snapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Snapshot object. The service call response (type Amazon.Redshift.Model.CopyClusterSnapshotResponse) 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=Copy-RSClusterSnapshot.html&tocid=Copy-RSClusterSnapshot</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Disable-RSLogging</name> <description> <para>Invokes the DisableLogging operation against Amazon Redshift.</para> </description> <verb>Disable</verb> <noun>RSLogging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. </para> </description> <syntax> <syntaxItem> <name>Disable-RSLogging</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster on which logging is to be stopped. Example: <code>examplecluster</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster on which logging is to be stopped. Example: <code>examplecluster</code> </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.DisableLoggingResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Redshift.Model.DisableLoggingResponse 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=Disable-RSLogging.html&tocid=Disable-RSLogging</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Disable-RSSnapshotCopy</name> <description> <para>Invokes the DisableSnapshotCopy operation against Amazon Redshift.</para> </description> <verb>Disable</verb> <noun>RSSnapshotCopy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use <a>DeleteSnapshotCopyGrant</a> to delete the grant that grants Amazon Redshift permission to the CMK in the destination region. </para> </description> <syntax> <syntaxItem> <name>Disable-RSSnapshotCopy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.DisableSnapshotCopyResponse) 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=Disable-RSSnapshotCopy.html&tocid=Disable-RSSnapshotCopy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Edit-RSCluster</name> <description> <para>Invokes the ModifyCluster operation against Amazon Redshift.</para> </description> <verb>Edit</verb> <noun>RSCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. </para> </description> <syntax> <syntaxItem> <name>Edit-RSCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster to be modified. Example: <code>examplecluster</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowVersionUpgrade</name> <description> <para>If <code>true</code>, major version upgrades will be applied automatically to the cluster during the maintenance window. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutomatedSnapshotRetentionPeriod</name> <description> <para>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted. Default: Uses existing setting. Constraints: Must be a value from 0 to 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClusterParameterGroupName</name> <description> <para>The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use <a>RebootCluster</a>. Default: Uses existing setting. Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClusterSecurityGroup</name> <description> <para>A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible. Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster. Constraints: - Must be 1 to 255 alphanumeric characters or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClusterType</name> <description> <para>The new cluster type. When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use <a>DescribeResize</a> to track the progress of the resize request. Valid Values: <code> multi-node | single-node </code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ClusterVersion</name> <description> <para>The new version number of the Amazon Redshift engine to upgrade to. For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. Example: <code>1.0</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported Platforms to Launch Your Cluster</a> in the Amazon Redshift Cluster Management Guide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnhancedVpcRouting</name> <description> <para>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide. If this option is <code>true</code>, enhanced VPC routing is enabled. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HsmConfigurationIdentifier</name> <description> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost. Default: Uses existing setting. Constraints: - Must be between 8 and 64 characters in length. - Must contain at least one uppercase letter. - Must contain at least one lowercase letter. - Must contain one number. - Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NewClusterIdentifier</name> <description> <para>The new identifier for the cluster. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account. Example: <code>examplecluster</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NodeType</name> <description> <para>The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use <a>DescribeResize</a> to track the progress of the resize request. Valid Values: <code> ds1.xlarge</code> | <code>ds1.8xlarge</code> | <code> ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NumberOfNodes</name> <description> <para>The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use <a>DescribeResize</a> to track the progress of the resize request. Valid Values: Integer greater than <code>0</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage. This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied. Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi, for example <code>wed:07:30-wed:08:00</code>. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>If <code>true</code>, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of virtual private cloud (VPC) security groups to be associated with the cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowVersionUpgrade</name> <description> <para>If <code>true</code>, major version upgrades will be applied automatically to the cluster during the maintenance window. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutomatedSnapshotRetentionPeriod</name> <description> <para>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted. Default: Uses existing setting. Constraints: Must be a value from 0 to 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster to be modified. Example: <code>examplecluster</code> </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="False" position="Named"> <name>ClusterParameterGroupName</name> <description> <para>The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use <a>RebootCluster</a>. Default: Uses existing setting. Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version. </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="False" position="Named"> <name>ClusterSecurityGroup</name> <description> <para>A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible. Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster. Constraints: - Must be 1 to 255 alphanumeric characters or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </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="False" position="Named"> <name>ClusterType</name> <description> <para>The new cluster type. When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use <a>DescribeResize</a> to track the progress of the resize request. Valid Values: <code> multi-node | single-node </code> </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>ClusterVersion</name> <description> <para>The new version number of the Amazon Redshift engine to upgrade to. For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. Example: <code>1.0</code> </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="False" position="Named"> <name>ElasticIp</name> <description> <para>The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported Platforms to Launch Your Cluster</a> in the Amazon Redshift Cluster Management Guide. </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="False" position="Named"> <name>EnhancedVpcRouting</name> <description> <para>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide. If this option is <code>true</code>, enhanced VPC routing is enabled. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. </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>HsmConfigurationIdentifier</name> <description> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. </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="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost. Default: Uses existing setting. Constraints: - Must be between 8 and 64 characters in length. - Must contain at least one uppercase letter. - Must contain at least one lowercase letter. - Must contain one number. - Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space. </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="False" position="Named"> <name>NewClusterIdentifier</name> <description> <para>The new identifier for the cluster. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account. Example: <code>examplecluster</code> </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="False" position="Named"> <name>NodeType</name> <description> <para>The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use <a>DescribeResize</a> to track the progress of the resize request. Valid Values: <code> ds1.xlarge</code> | <code>ds1.8xlarge</code> | <code> ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code>. </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="False" position="Named"> <name>NumberOfNodes</name> <description> <para>The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use <a>DescribeResize</a> to track the progress of the resize request. Valid Values: Integer greater than <code>0</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage. This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied. Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi, for example <code>wed:07:30-wed:08:00</code>. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes. </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="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>If <code>true</code>, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of virtual private cloud (VPC) security groups to be associated with the cluster. </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.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.ModifyClusterResponse) 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=Edit-RSCluster.html&tocid=Edit-RSCluster</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Edit-RSClusterIamRole</name> <description> <para>Invokes the ModifyClusterIamRoles operation against Amazon Redshift.</para> </description> <verb>Edit</verb> <noun>RSClusterIamRole</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. A cluster can have up to 10 IAM roles associated at any time. </para> </description> <syntax> <syntaxItem> <name>Edit-RSClusterIamRole</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster for which you want to associate or disassociate IAM roles. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AddIamRole</name> <description> <para>Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RemoveIamRole</name> <description> <para>Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AddIamRole</name> <description> <para>Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request. </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 (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster for which you want to associate or disassociate IAM roles. </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="False" 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="False" position="Named"> <name>RemoveIamRole</name> <description> <para>Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request. </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.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.ModifyClusterIamRolesResponse) 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=Edit-RSClusterIamRole.html&tocid=Edit-RSClusterIamRole</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Edit-RSClusterParameterGroup</name> <description> <para>Invokes the ModifyClusterParameterGroup operation against Amazon Redshift.</para> </description> <verb>Edit</verb> <noun>RSClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the parameters of a parameter group. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Edit-RSClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of the parameter group to be modified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Parameter</name> <description> <para>An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional. For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Parameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>Parameter</name> <description> <para>An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional. For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Parameter[]</parameterValue> <type> <name>Amazon.Redshift.Model.Parameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of the parameter group to be modified. </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.Redshift.Model.ModifyClusterParameterGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Redshift.Model.ModifyClusterParameterGroupResponse 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=Edit-RSClusterParameterGroup.html&tocid=Edit-RSClusterParameterGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Edit-RSClusterSubnetGroup</name> <description> <para>Invokes the ModifyClusterSubnetGroup operation against Amazon Redshift.</para> </description> <verb>Edit</verb> <noun>RSClusterSubnetGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets. </para> </description> <syntax> <syntaxItem> <name>Edit-RSClusterSubnetGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSubnetGroupName</name> <description> <para>The name of the subnet group to be modified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Description</name> <description> <para>A text description of the subnet group to be modified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SubnetId</name> <description> <para>An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSubnetGroupName</name> <description> <para>The name of the subnet group to be modified. </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="False" position="2"> <name>Description</name> <description> <para>A text description of the subnet group to be modified. </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="False" 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="False" position="3"> <name>SubnetId</name> <description> <para>An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. </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.Redshift.Model.ClusterSubnetGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ClusterSubnetGroup object. The service call response (type Amazon.Redshift.Model.ModifyClusterSubnetGroupResponse) 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=Edit-RSClusterSubnetGroup.html&tocid=Edit-RSClusterSubnetGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Edit-RSEventSubscription</name> <description> <para>Invokes the ModifyEventSubscription operation against Amazon Redshift.</para> </description> <verb>Edit</verb> <noun>RSEventSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies an existing Amazon Redshift event notification subscription. </para> </description> <syntax> <syntaxItem> <name>Edit-RSEventSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para>A Boolean value indicating if the subscription is enabled. <code>true</code> indicates the subscription is enabled </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para>Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: Configuration, Management, Monitoring, Security </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Severity</name> <description> <para>Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceId</name> <description> <para>A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010 </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SubscriptionName</name> <description> <para>The name of the modified Amazon Redshift event notification subscription. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para>A Boolean value indicating if the subscription is enabled. <code>true</code> indicates the subscription is enabled </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para>Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: Configuration, Management, Monitoring, Security </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="False" 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="False" position="Named"> <name>Severity</name> <description> <para>Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO </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="False" position="Named"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription. </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="False" position="Named"> <name>SourceId</name> <description> <para>A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010 </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="False" position="Named"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot. </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>SubscriptionName</name> <description> <para>The name of the modified Amazon Redshift event notification subscription. </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.Redshift.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventSubscription object. The service call response (type Amazon.Redshift.Model.ModifyEventSubscriptionResponse) 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=Edit-RSEventSubscription.html&tocid=Edit-RSEventSubscription</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Edit-RSSnapshotCopyRetentionPeriod</name> <description> <para>Invokes the ModifySnapshotCopyRetentionPeriod operation against Amazon Redshift.</para> </description> <verb>Edit</verb> <noun>RSSnapshotCopyRetentionPeriod</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region. </para> </description> <syntax> <syntaxItem> <name>Edit-RSSnapshotCopyRetentionPeriod</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetentionPeriod</name> <description> <para>The number of days to retain automated snapshots in the destination region after they are copied from the source region. If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period. Constraints: Must be at least 1 and no more than 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. </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="False" 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="False" position="Named"> <name>RetentionPeriod</name> <description> <para>The number of days to retain automated snapshots in the destination region after they are copied from the source region. If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period. Constraints: Must be at least 1 and no more than 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.ModifySnapshotCopyRetentionPeriodResponse) 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=Edit-RSSnapshotCopyRetentionPeriod.html&tocid=Edit-RSSnapshotCopyRetentionPeriod</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Enable-RSLogging</name> <description> <para>Invokes the EnableLogging operation against Amazon Redshift.</para> </description> <verb>Enable</verb> <noun>RSLogging</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. </para> </description> <syntax> <syntaxItem> <name>Enable-RSLogging</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster on which logging is to be started. Example: <code>examplecluster</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BucketName</name> <description> <para>The name of an existing S3 bucket where the log files are to be stored. Constraints: - Must be in the same region as the cluster - The cluster must have read bucket and put object permissions </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3KeyPrefix</name> <description> <para>The prefix applied to the log file names. Constraints: - Cannot exceed 512 characters - Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are: - x00 to x20 - x22 - x27 - x5c - x7f or larger </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BucketName</name> <description> <para>The name of an existing S3 bucket where the log files are to be stored. Constraints: - Must be in the same region as the cluster - The cluster must have read bucket and put object permissions </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 (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster on which logging is to be started. Example: <code>examplecluster</code> </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="False" 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="False" position="Named"> <name>S3KeyPrefix</name> <description> <para>The prefix applied to the log file names. Constraints: - Cannot exceed 512 characters - Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are: - x00 to x20 - x22 - x27 - x5c - x7f or larger </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.Redshift.Model.EnableLoggingResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Redshift.Model.EnableLoggingResponse 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=Enable-RSLogging.html&tocid=Enable-RSLogging</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Enable-RSSnapshotCopy</name> <description> <para>Invokes the EnableSnapshotCopy operation against Amazon Redshift.</para> </description> <verb>Enable</verb> <noun>RSSnapshotCopy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables the automatic copy of snapshots from one region to another region for a specified cluster. </para> </description> <syntax> <syntaxItem> <name>Enable-RSSnapshotCopy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the source cluster to copy snapshots from. Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DestinationRegion</name> <description> <para>The destination region that you want to copy snapshots to. Constraints: Must be the name of a valid region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region">Regions and Endpoints</a> in the Amazon Web Services General Reference. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetentionPeriod</name> <description> <para>The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default: 7. Constraints: Must be at least 1 and no more than 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotCopyGrantName</name> <description> <para>The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the source cluster to copy snapshots from. Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled. </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="False" position="Named"> <name>DestinationRegion</name> <description> <para>The destination region that you want to copy snapshots to. Constraints: Must be the name of a valid region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region">Regions and Endpoints</a> in the Amazon Web Services General Reference. </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="False" 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="False" position="Named"> <name>RetentionPeriod</name> <description> <para>The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default: 7. Constraints: Must be at least 1 and no more than 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotCopyGrantName</name> <description> <para>The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. </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.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.EnableSnapshotCopyResponse) 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=Enable-RSSnapshotCopy.html&tocid=Enable-RSSnapshotCopy</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSCluster</name> <description> <para>Invokes the DescribeClusters operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned. If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. Constraints: You can specify either the <b>ClusterIdentifier</b> parameter or the <b>Marker</b> parameter, but not both. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned. </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="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. Constraints: You can specify either the <b>ClusterIdentifier</b> parameter or the <b>Marker</b> parameter, but not both. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them. </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.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Cluster objects. The service call response (type Amazon.Redshift.Model.DescribeClustersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSCluster.html&tocid=Get-RSCluster</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSClusterCredential</name> <description> <para>Invokes the GetClusterCredentials operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSClusterCredential</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with <code>IAM:</code> if <code>AutoCreate</code> is <code>False</code> or <code>IAMA:</code> if <code>AutoCreate</code> is <code>True</code>. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html">Using IAM Authentication to Generate Database User Credentials</a> in the Amazon Redshift Cluster Management Guide. The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources">Resource Policies for GetClusterCredentials</a> in the Amazon Redshift Cluster Management Guide. If the <code>DbGroups</code> parameter is specified, the IAM policy must allow the <code>redshift:JoinGroup</code> action with access to the listed <code>dbgroups</code>. In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>, then the policy must include the <code>redshift:CreateClusterUser</code> privilege. If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource <code>dbname</code> for the specified database name. </para> </description> <syntax> <syntaxItem> <name>Get-RSClusterCredential</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoCreate</name> <description> <para>Create a database user with the name specified for the user named in <code>DbUser</code> if one does not exist. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbGroup</name> <description> <para>A list of the names of existing database groups that the user named in <code>DbUser</code> will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints - Must be 1 to 64 alphanumeric characters or hyphens - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. - First character must be a letter. - Must not contain a colon ( : ) or slash ( / ). - Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbName</name> <description> <para>The name of a database that <code>DbUser</code> is authorized to log on to. If <code>DbName</code> is not specified, <code>DbUser</code> can log on to any existing database. Constraints: - Must be 1 to 64 alphanumeric characters or hyphens - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. - First character must be a letter. - Must not contain a colon ( : ) or slash ( / ). - Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbUser</name> <description> <para>The name of a database user. If a user name matching <code>DbUser</code> exists in the database, the temporary user credentials have the same permissions as the existing user. If <code>DbUser</code> doesn't exist in the database and <code>Autocreate</code> is <code>True</code>, a new user is created using the value for <code>DbUser</code> with PUBLIC permissions. If a database user matching the value for <code>DbUser</code> doesn't exist and <code>Autocreate</code> is <code>False</code>, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database. For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">CREATE USER</a> in the Amazon Redshift Database Developer Guide. Constraints: - Must be 1 to 64 alphanumeric characters or hyphens - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. - First character must be a letter. - Must not contain a colon ( : ) or slash ( / ). - Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DurationSecond</name> <description> <para>The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoCreate</name> <description> <para>Create a database user with the name specified for the user named in <code>DbUser</code> if one does not exist. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive. </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="False" position="Named"> <name>DbGroup</name> <description> <para>A list of the names of existing database groups that the user named in <code>DbUser</code> will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints - Must be 1 to 64 alphanumeric characters or hyphens - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. - First character must be a letter. - Must not contain a colon ( : ) or slash ( / ). - Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </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="False" position="Named"> <name>DbName</name> <description> <para>The name of a database that <code>DbUser</code> is authorized to log on to. If <code>DbName</code> is not specified, <code>DbUser</code> can log on to any existing database. Constraints: - Must be 1 to 64 alphanumeric characters or hyphens - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. - First character must be a letter. - Must not contain a colon ( : ) or slash ( / ). - Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </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="False" position="Named"> <name>DbUser</name> <description> <para>The name of a database user. If a user name matching <code>DbUser</code> exists in the database, the temporary user credentials have the same permissions as the existing user. If <code>DbUser</code> doesn't exist in the database and <code>Autocreate</code> is <code>True</code>, a new user is created using the value for <code>DbUser</code> with PUBLIC permissions. If a database user matching the value for <code>DbUser</code> doesn't exist and <code>Autocreate</code> is <code>False</code>, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database. For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">CREATE USER</a> in the Amazon Redshift Database Developer Guide. Constraints: - Must be 1 to 64 alphanumeric characters or hyphens - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. - First character must be a letter. - Must not contain a colon ( : ) or slash ( / ). - Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </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="False" position="Named"> <name>DurationSecond</name> <description> <para>The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.GetClusterCredentialsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Redshift.Model.GetClusterCredentialsResponse 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-RSClusterCredential.html&tocid=Get-RSClusterCredential</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSClusterParameter</name> <description> <para>Invokes the DescribeClusterParameters operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSClusterParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. You can specify <i>source</i> filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from <a>ModifyClusterParameterGroup</a>, you can specify <i>source</i> equal to <i>user</i>. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSClusterParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of a cluster parameter group for which to return details. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Source</name> <description> <para>The parameter types to return. Specify <code>user</code> to show parameters that are different form the default. Similarly, specify <code>engine-default</code> to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: <code>user</code> | <code>engine-default</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterParameters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterParameters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of a cluster parameter group for which to return details. </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="False" position="2"> <name>Source</name> <description> <para>The parameter types to return. Specify <code>user</code> to show parameters that are different form the default. Similarly, specify <code>engine-default</code> to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: <code>user</code> | <code>engine-default</code> </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.Redshift.Model.Parameter</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Parameter objects. The service call response (type Amazon.Redshift.Model.DescribeClusterParametersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSClusterParameter.html&tocid=Get-RSClusterParameter</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSClusterParameterGroup</name> <description> <para>Invokes the DescribeClusterParameterGroups operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all parameter groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterParameterGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterParameterGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned. </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="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them. </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.Redshift.Model.ClusterParameterGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ClusterParameterGroup objects. The service call response (type Amazon.Redshift.Model.DescribeClusterParameterGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSClusterParameterGroup.html&tocid=Get-RSClusterParameterGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSClusterSecurityGroup</name> <description> <para>Invokes the DescribeClusterSecurityGroups operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSClusterSecurityGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all security groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSClusterSecurityGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name of a cluster security group for which you are requesting details. You can specify either the <b>Marker</b> parameter or a <b>ClusterSecurityGroupName</b> parameter, but not both. Example: <code>securitygroup1</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSecurityGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. Constraints: You can specify either the <b>ClusterSecurityGroupName</b> parameter or the <b>Marker</b> parameter, but not both. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name of a cluster security group for which you are requesting details. You can specify either the <b>Marker</b> parameter or a <b>ClusterSecurityGroupName</b> parameter, but not both. Example: <code>securitygroup1</code> </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="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSecurityGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. Constraints: You can specify either the <b>ClusterSecurityGroupName</b> parameter or the <b>Marker</b> parameter, but not both. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them. </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.Redshift.Model.ClusterSecurityGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ClusterSecurityGroup objects. The service call response (type Amazon.Redshift.Model.DescribeClusterSecurityGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSClusterSecurityGroup.html&tocid=Get-RSClusterSecurityGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSClusterSnapshot</name> <description> <para>Invokes the DescribeClusterSnapshots operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster for which information about snapshots is requested. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>SnapshotIdentifier</name> <description> <para>The snapshot identifier of the snapshot about which to return information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SnapshotType</name> <description> <para>The type of snapshots for which you are requesting information. By default, snapshots of all types are returned. Valid Values: <code>automated</code> | <code>manual</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: <code>2012-07-16T18:00:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OwnerAccount</name> <description> <para>The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para>A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: <code>2012-07-16T18:00:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSnapshots</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster for which information about snapshots is requested. </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="False" position="Named"> <name>EndTime</name> <description> <para>A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: <code>2012-07-16T18:00:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSnapshots</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OwnerAccount</name> <description> <para>The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter. </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="2"> <name>SnapshotIdentifier</name> <description> <para>The snapshot identifier of the snapshot about which to return 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="False" position="3"> <name>SnapshotType</name> <description> <para>The type of snapshots for which you are requesting information. By default, snapshots of all types are returned. Valid Values: <code>automated</code> | <code>manual</code> </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="False" position="Named"> <name>StartTime</name> <description> <para>A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: <code>2012-07-16T18:00:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them. </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.Redshift.Model.Snapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Snapshot objects. The service call response (type Amazon.Redshift.Model.DescribeClusterSnapshotsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSClusterSnapshot.html&tocid=Get-RSClusterSnapshot</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSClusterSubnetGroup</name> <description> <para>Invokes the DescribeClusterSubnetGroups operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSClusterSubnetGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all subnet groups that have any combination of those values are returned. If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSClusterSubnetGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSubnetGroupName</name> <description> <para>The name of the cluster subnet group for which information is requested. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSubnetGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSubnetGroupName</name> <description> <para>The name of the cluster subnet group for which information is requested. </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="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSubnetGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them. </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.Redshift.Model.ClusterSubnetGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ClusterSubnetGroup objects. The service call response (type Amazon.Redshift.Model.DescribeClusterSubnetGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSClusterSubnetGroup.html&tocid=Get-RSClusterSubnetGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSClusterVersion</name> <description> <para>Invokes the DescribeClusterVersions operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSClusterVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSClusterVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterVersion</name> <description> <para>The specific cluster version to return. Example: <code>1.0</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ClusterParameterGroupFamily</name> <description> <para>The name of a specific cluster parameter group family to return details for. Constraints: - Must be 1 to 255 alphanumeric characters - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterVersions</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ClusterParameterGroupFamily</name> <description> <para>The name of a specific cluster parameter group family to return details for. Constraints: - Must be 1 to 255 alphanumeric characters - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </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 (ByValue, ByPropertyName)" position="1"> <name>ClusterVersion</name> <description> <para>The specific cluster version to return. Example: <code>1.0</code> </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="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterVersions</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.ClusterVersion</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ClusterVersion objects. The service call response (type Amazon.Redshift.Model.DescribeClusterVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSClusterVersion.html&tocid=Get-RSClusterVersion</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSDefaultClusterParameter</name> <description> <para>Invokes the DescribeDefaultClusterParameters operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSDefaultClusterParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Get-RSDefaultClusterParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ParameterGroupFamily</name> <description> <para>The name of the cluster parameter group family. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeDefaultClusterParameters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeDefaultClusterParameters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ParameterGroupFamily</name> <description> <para>The name of the cluster parameter group family. </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.Redshift.Model.DefaultClusterParameters</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DefaultClusterParameters object. The service call response (type Amazon.Redshift.Model.DescribeDefaultClusterParametersResponse) 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-RSDefaultClusterParameter.html&tocid=Get-RSDefaultClusterParameter</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSEvent</name> <description> <para>Invokes the DescribeEvents operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSEvent</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSEvent</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceIdentifier</name> <description> <para>The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response. Constraints: If <i>SourceIdentifier</i> is supplied, <i>SourceType</i> must also be provided. - Specify a cluster identifier when <i>SourceType</i> is <code>cluster</code>. - Specify a cluster security group name when <i>SourceType</i> is <code>cluster-security-group</code>. - Specify a cluster parameter group name when <i>SourceType</i> is <code>cluster-parameter-group</code>. - Specify a cluster snapshot identifier when <i>SourceType</i> is <code>cluster-snapshot</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SourceType</name> <description> <para>The event source to retrieve events for. If no value is specified, all events are returned. Constraints: If <i>SourceType</i> is supplied, <i>SourceIdentifier</i> must also be provided. - Specify <code>cluster</code> when <i>SourceIdentifier</i> is a cluster identifier. - Specify <code>cluster-security-group</code> when <i>SourceIdentifier</i> is a cluster security group name. - Specify <code>cluster-parameter-group</code> when <i>SourceIdentifier</i> is a cluster parameter group name. - Specify <code>cluster-snapshot</code> when <i>SourceIdentifier</i> is a cluster snapshot identifier. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. Default: <code>60</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: <code>2009-07-08T18:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: <code>2009-07-08T18:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeEvents</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. Default: <code>60</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para>The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: <code>2009-07-08T18:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeEvents</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceIdentifier</name> <description> <para>The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response. Constraints: If <i>SourceIdentifier</i> is supplied, <i>SourceType</i> must also be provided. - Specify a cluster identifier when <i>SourceType</i> is <code>cluster</code>. - Specify a cluster security group name when <i>SourceType</i> is <code>cluster-security-group</code>. - Specify a cluster parameter group name when <i>SourceType</i> is <code>cluster-parameter-group</code>. - Specify a cluster snapshot identifier when <i>SourceType</i> is <code>cluster-snapshot</code>. </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="False" position="2"> <name>SourceType</name> <description> <para>The event source to retrieve events for. If no value is specified, all events are returned. Constraints: If <i>SourceType</i> is supplied, <i>SourceIdentifier</i> must also be provided. - Specify <code>cluster</code> when <i>SourceIdentifier</i> is a cluster identifier. - Specify <code>cluster-security-group</code> when <i>SourceIdentifier</i> is a cluster security group name. - Specify <code>cluster-parameter-group</code> when <i>SourceIdentifier</i> is a cluster parameter group name. - Specify <code>cluster-snapshot</code> when <i>SourceIdentifier</i> is a cluster snapshot identifier. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.SourceType</parameterValue> <type> <name>Amazon.Redshift.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: <code>2009-07-08T18:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.Event</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Event objects. The service call response (type Amazon.Redshift.Model.DescribeEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSEvent.html&tocid=Get-RSEvent</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSEventCategory</name> <description> <para>Invokes the DescribeEventCategories operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSEventCategory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html">Amazon Redshift Event Notifications</a>. </para> </description> <syntax> <syntaxItem> <name>Get-RSEventCategory</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceType</name> <description> <para>The source type, such as cluster or parameter group, to which the described event categories apply. Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceType</name> <description> <para>The source type, such as cluster or parameter group, to which the described event categories apply. Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group. </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.Redshift.Model.EventCategoriesMap</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of EventCategoriesMap objects. The service call response (type Amazon.Redshift.Model.DescribeEventCategoriesResponse) 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-RSEventCategory.html&tocid=Get-RSEventCategory</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSEventSubscription</name> <description> <para>Invokes the DescribeEventSubscriptions operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSEventSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all subscriptions that have any combination of those values are returned. If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSEventSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SubscriptionName</name> <description> <para>The name of the Amazon Redshift event notification subscription to be described. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SubscriptionName</name> <description> <para>The name of the Amazon Redshift event notification subscription to be described. </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="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them. </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.Redshift.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of EventSubscription objects. The service call response (type Amazon.Redshift.Model.DescribeEventSubscriptionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSEventSubscription.html&tocid=Get-RSEventSubscription</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSHsmClientCertificate</name> <description> <para>Invokes the DescribeHsmClientCertificates operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSHsmClientCertificate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM client certificates that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSHsmClientCertificate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeHsmClientCertificates</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account. </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="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeHsmClientCertificates</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them. </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.Redshift.Model.HsmClientCertificate</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HsmClientCertificate objects. The service call response (type Amazon.Redshift.Model.DescribeHsmClientCertificatesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSHsmClientCertificate.html&tocid=Get-RSHsmClientCertificate</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSHsmConfiguration</name> <description> <para>Invokes the DescribeHsmConfigurations operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSHsmConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM connections that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSHsmConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HsmConfigurationIdentifier</name> <description> <para>The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeHsmConfigurations</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HsmConfigurationIdentifier</name> <description> <para>The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account. </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="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeHsmConfigurations</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them. </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.Redshift.Model.HsmConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HsmConfiguration objects. The service call response (type Amazon.Redshift.Model.DescribeHsmConfigurationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSHsmConfiguration.html&tocid=Get-RSHsmConfiguration</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSLoggingStatus</name> <description> <para>Invokes the DescribeLoggingStatus operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSLoggingStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. </para> </description> <syntax> <syntaxItem> <name>Get-RSLoggingStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster from which to get the logging status. Example: <code>examplecluster</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster from which to get the logging status. Example: <code>examplecluster</code> </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.Redshift.Model.DescribeLoggingStatusResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Redshift.Model.DescribeLoggingStatusResponse 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-RSLoggingStatus.html&tocid=Get-RSLoggingStatus</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSOrderableClusterOption</name> <description> <para>Invokes the DescribeOrderableClusterOptions operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSOrderableClusterOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSOrderableClusterOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterVersion</name> <description> <para>The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from <a>DescribeClusterVersions</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>NodeType</name> <description> <para>The node type filter value. Specify this parameter to show only the available offerings matching the specified node type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeOrderableClusterOptions</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterVersion</name> <description> <para>The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from <a>DescribeClusterVersions</a>. </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="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeOrderableClusterOptions</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>NodeType</name> <description> <para>The node type filter value. Specify this parameter to show only the available offerings matching the specified node type. </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.Redshift.Model.OrderableClusterOption</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of OrderableClusterOption objects. The service call response (type Amazon.Redshift.Model.DescribeOrderableClusterOptionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSOrderableClusterOption.html&tocid=Get-RSOrderableClusterOption</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSReservedNode</name> <description> <para>Invokes the DescribeReservedNodes operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSReservedNode</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the descriptions of the reserved nodes.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSReservedNode</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedNodeId</name> <description> <para>Identifier for the node reservation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeReservedNodes</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeReservedNodes</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedNodeId</name> <description> <para>Identifier for the node reservation. </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.Redshift.Model.ReservedNode</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ReservedNode objects. The service call response (type Amazon.Redshift.Model.DescribeReservedNodesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSReservedNode.html&tocid=Get-RSReservedNode</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSReservedNodeOffering</name> <description> <para>Invokes the DescribeReservedNodeOfferings operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSReservedNodeOffering</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to <a>PurchaseReservedNodeOffering</a> to reserve one or more nodes for your Amazon Redshift cluster. For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSReservedNodeOffering</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedNodeOfferingId</name> <description> <para>The unique identifier for the offering. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeReservedNodeOfferings</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeReservedNodeOfferings</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedNodeOfferingId</name> <description> <para>The unique identifier for the offering. </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.Redshift.Model.ReservedNodeOffering</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ReservedNodeOffering objects. The service call response (type Amazon.Redshift.Model.DescribeReservedNodeOfferingsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSReservedNodeOffering.html&tocid=Get-RSReservedNodeOffering</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSResize</name> <description> <para>Invokes the DescribeResize operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSResize</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a <code>HTTP 404</code> error is returned. If a resize operation was initiated and completed, the status of the resize remains as <code>SUCCEEDED</code> until the next resize. A resize operation can be requested using <a>ModifyCluster</a> and specifying a different number or type of nodes for the cluster. </para> </description> <syntax> <syntaxItem> <name>Get-RSResize</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an AWS account are returned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an AWS account are returned. </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.Redshift.Model.DescribeResizeResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Redshift.Model.DescribeResizeResponse 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-RSResize.html&tocid=Get-RSResize</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSResourceTag</name> <description> <para>Invokes the DescribeTags operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. The following are limitations for <code>DescribeTags</code>: - You cannot specify an ARN and a resource-type value together in the same request. - You cannot use the <code>MaxRecords</code> and <code>Marker</code> parameters together with the ARN parameter. - The <code>MaxRecords</code> parameter can be a range from 10 to 50 results to return in a request. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all resources that have any combination of those values are returned. If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceName</name> <description> <para>The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of resource with which you want to view tags. Valid resource types are: - Cluster - CIDR/IP - EC2 security group - Snapshot - Cluster security group - Subnet group - HSM connection - HSM certificate - Parameter group - Snapshot copy grant For more information about Amazon Redshift resource types and constructing ARNs, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions">Specifying Policy Elements: Actions, Effects, Resources, and Principals</a> in the Amazon Redshift Cluster Management Guide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the <code>marker</code> parameter and retrying the command. If the <code>marker</code> field is empty, all response records have been retrieved for the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned <code>marker</code> value. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the <code>marker</code> parameter and retrying the command. If the <code>marker</code> field is empty, all response records have been retrieved for the request. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned <code>marker</code> value. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceName</name> <description> <para>The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of resource with which you want to view tags. Valid resource types are: - Cluster - CIDR/IP - EC2 security group - Snapshot - Cluster security group - Subnet group - HSM connection - HSM certificate - Parameter group - Snapshot copy grant For more information about Amazon Redshift resource types and constructing ARNs, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions">Specifying Policy Elements: Actions, Effects, Resources, and Principals</a> in the Amazon Redshift Cluster Management Guide. </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="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them. </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.Redshift.Model.TaggedResource</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TaggedResource objects. The service call response (type Amazon.Redshift.Model.DescribeTagsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSResourceTag.html&tocid=Get-RSResourceTag</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSSnapshotCopyGrant</name> <description> <para>Invokes the DescribeSnapshotCopyGrants operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSSnapshotCopyGrant</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of snapshot copy grants owned by the AWS account in the destination region. For more information about managing snapshot copy grants, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSSnapshotCopyGrant</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotCopyGrantName</name> <description> <para>The name of the snapshot copy grant. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeSnapshotCopyGrant</code> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. Constraints: You can specify either the <b>SnapshotCopyGrantName</b> parameter or the <b>Marker</b> parameter, but not both. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeSnapshotCopyGrant</code> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. Constraints: You can specify either the <b>SnapshotCopyGrantName</b> parameter or the <b>Marker</b> parameter, but not both. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: <code>100</code> Constraints: minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotCopyGrantName</name> <description> <para>The name of the snapshot copy grant. </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="False" position="Named"> <name>TagKey</name> <description> <para>A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them. </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="False" position="Named"> <name>TagValue</name> <description> <para>A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them. </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.Redshift.Model.SnapshotCopyGrant</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of SnapshotCopyGrant objects. The service call response (type Amazon.Redshift.Model.DescribeSnapshotCopyGrantsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSSnapshotCopyGrant.html&tocid=Get-RSSnapshotCopyGrant</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Get-RSTableRestoreStatus</name> <description> <para>Invokes the DescribeTableRestoreStatus operation against Amazon Redshift.</para> </description> <verb>Get</verb> <noun>RSTableRestoreStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the status of one or more table restore requests made using the <a>RestoreTableFromClusterSnapshot</a> API action. If you don't specify a value for the <code>TableRestoreRequestId</code> parameter, then <code>DescribeTableRestoreStatus</code> returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise <code>DescribeTableRestoreStatus</code> returns the status of the table specified by <code>TableRestoreRequestId</code>.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RSTableRestoreStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The Amazon Redshift cluster that the table is being restored to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TableRestoreRequestId</name> <description> <para>The identifier of the table restore request to return status for. If you don't specify a <code>TableRestoreRequestId</code> value, then <code>DescribeTableRestoreStatus</code> returns the status of all in-progress table restore requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional pagination token provided by a previous <code>DescribeTableRestoreStatus</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The Amazon Redshift cluster that the table is being restored to. </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="False" position="Named"> <name>Marker</name> <description> <para>An optional pagination token provided by a previous <code>DescribeTableRestoreStatus</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TableRestoreRequestId</name> <description> <para>The identifier of the table restore request to return status for. If you don't specify a <code>TableRestoreRequestId</code> value, then <code>DescribeTableRestoreStatus</code> returns the status of all in-progress table restore requests. </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.Redshift.Model.TableRestoreStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TableRestoreStatus objects. The service call response (type Amazon.Redshift.Model.DescribeTableRestoreStatusResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RSTableRestoreStatus.html&tocid=Get-RSTableRestoreStatus</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSCluster</name> <description> <para>Invokes the CreateCluster operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new cluster. To create the cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>New-RSCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBName</name> <description> <para>The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html">Create a Database</a> in the Amazon Redshift Database Developer Guide. Default: <code>dev</code> Constraints: - Must contain 1 to 64 alphanumeric characters. - Must contain only lowercase letters. - Cannot be a word that is reserved by the service. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>ClusterIdentifier</name> <description> <para>A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account. Example: <code>myexamplecluster</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>ClusterType</name> <description> <para>The type of the cluster. When cluster type is specified as - <code>single-node</code>, the <b>NumberOfNodes</b> parameter is not required. - <code>multi-node</code>, the <b>NumberOfNodes</b> parameter is required. Valid Values: <code>multi-node</code> | <code>single-node</code> Default: <code>multi-node</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>NodeType</name> <description> <para>The node type to be provisioned for the cluster. For information about node types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. Valid Values: <code>ds1.xlarge</code> | <code>ds1.8xlarge</code> | <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdditionalInfo</name> <description> <para>Reserved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowVersionUpgrade</name> <description> <para>If <code>true</code>, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutomatedSnapshotRetentionPeriod</name> <description> <para>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. Default: <code>1</code> Constraints: Must be a value from 0 to 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: <code>us-east-1d</code> Constraint: The specified Availability Zone must be in the same region as the current endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClusterParameterGroupName</name> <description> <para>The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon Redshift Parameter Groups</a> Constraints: - Must be 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClusterSecurityGroup</name> <description> <para>A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ClusterSubnetGroupName</name> <description> <para>The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ClusterVersion</name> <description> <para>The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: <code>1.0</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported Platforms to Launch Your Cluster</a> in the Amazon Redshift Cluster Management Guide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Encrypted</name> <description> <para>If <code>true</code>, the data in the cluster is encrypted at rest. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnhancedVpcRouting</name> <description> <para>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide. If this option is <code>true</code>, enhanced VPC routing is enabled. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HsmConfigurationIdentifier</name> <description> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IamRole</name> <description> <para>A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUsername</name> <description> <para>The user name associated with the master user account for the cluster that is being created. Constraints: - Must be 1 - 128 alphanumeric characters. - First character must be a letter. - Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The password associated with the master user account for the cluster that is being created. Constraints: - Must be between 8 and 64 characters in length. - Must contain at least one uppercase letter. - Must contain at least one lowercase letter. - Must contain one number. - Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NumberOfNodes</name> <description> <para>The number of compute nodes in the cluster. This parameter is required when the <b>ClusterType</b> parameter is specified as <code>multi-node</code>. For information about determining how many nodes you need, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: <code>1</code> Constraints: Value must be at least 1 and no more than 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: <code>5439</code> Valid Values: <code>1150-65535</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows">Maintenance Windows</a> in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>If <code>true</code>, the cluster can be accessed from a public network. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdditionalInfo</name> <description> <para>Reserved. </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="False" position="Named"> <name>AllowVersionUpgrade</name> <description> <para>If <code>true</code>, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutomatedSnapshotRetentionPeriod</name> <description> <para>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. Default: <code>1</code> Constraints: Must be a value from 0 to 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: <code>us-east-1d</code> Constraint: The specified Availability Zone must be in the same region as the current endpoint. </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="2"> <name>ClusterIdentifier</name> <description> <para>A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account. Example: <code>myexamplecluster</code> </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="False" position="Named"> <name>ClusterParameterGroupName</name> <description> <para>The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon Redshift Parameter Groups</a> Constraints: - Must be 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </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="False" position="Named"> <name>ClusterSecurityGroup</name> <description> <para>A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. </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>ClusterSubnetGroupName</name> <description> <para>The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC). </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="False" position="3"> <name>ClusterType</name> <description> <para>The type of the cluster. When cluster type is specified as - <code>single-node</code>, the <b>NumberOfNodes</b> parameter is not required. - <code>multi-node</code>, the <b>NumberOfNodes</b> parameter is required. Valid Values: <code>multi-node</code> | <code>single-node</code> Default: <code>multi-node</code> </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>ClusterVersion</name> <description> <para>The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: <code>1.0</code> </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 (ByValue, ByPropertyName)" position="1"> <name>DBName</name> <description> <para>The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html">Create a Database</a> in the Amazon Redshift Database Developer Guide. Default: <code>dev</code> Constraints: - Must contain 1 to 64 alphanumeric characters. - Must contain only lowercase letters. - Cannot be a word that is reserved by the service. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </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="False" position="Named"> <name>ElasticIp</name> <description> <para>The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported Platforms to Launch Your Cluster</a> in the Amazon Redshift Cluster Management Guide. </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="False" position="Named"> <name>Encrypted</name> <description> <para>If <code>true</code>, the data in the cluster is encrypted at rest. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnhancedVpcRouting</name> <description> <para>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide. If this option is <code>true</code>, enhanced VPC routing is enabled. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. </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>HsmConfigurationIdentifier</name> <description> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. </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="False" position="Named"> <name>IamRole</name> <description> <para>A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time. </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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. </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="False" position="Named"> <name>MasterUsername</name> <description> <para>The user name associated with the master user account for the cluster that is being created. Constraints: - Must be 1 - 128 alphanumeric characters. - First character must be a letter. - Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </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="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The password associated with the master user account for the cluster that is being created. Constraints: - Must be between 8 and 64 characters in length. - Must contain at least one uppercase letter. - Must contain at least one lowercase letter. - Must contain one number. - Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space. </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="False" position="4"> <name>NodeType</name> <description> <para>The node type to be provisioned for the cluster. For information about node types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. Valid Values: <code>ds1.xlarge</code> | <code>ds1.8xlarge</code> | <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code>. </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="False" position="Named"> <name>NumberOfNodes</name> <description> <para>The number of compute nodes in the cluster. This parameter is required when the <b>ClusterType</b> parameter is specified as <code>multi-node</code>. For information about determining how many nodes you need, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: <code>1</code> Constraints: Value must be at least 1 and no more than 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: <code>5439</code> Valid Values: <code>1150-65535</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows">Maintenance Windows</a> in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window. </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="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>If <code>true</code>, the cluster can be accessed from a public network. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. </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.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.CreateClusterResponse) 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=New-RSCluster.html&tocid=New-RSCluster</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSClusterParameterGroup</name> <description> <para>Invokes the CreateClusterParameterGroup operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an Amazon Redshift parameter group. Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using <a>ModifyCluster</a>. Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>New-RSClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of the cluster parameter group. Constraints: - Must be 1 to 255 alphanumeric characters or hyphens - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique withing your AWS account. This value is stored as a lower-case string. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ParameterGroupFamily</name> <description> <para>The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call <a>DescribeClusterParameterGroups</a>. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0". </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Description</name> <description> <para>A description of the parameter group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Description</name> <description> <para>A description of the parameter group. </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="False" 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="False" position="2"> <name>ParameterGroupFamily</name> <description> <para>The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call <a>DescribeClusterParameterGroups</a>. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0". </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 (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of the cluster parameter group. Constraints: - Must be 1 to 255 alphanumeric characters or hyphens - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique withing your AWS account. This value is stored as a lower-case string. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.ClusterParameterGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ClusterParameterGroup object. The service call response (type Amazon.Redshift.Model.CreateClusterParameterGroupResponse) 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=New-RSClusterParameterGroup.html&tocid=New-RSClusterParameterGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSClusterSecurityGroup</name> <description> <para>Invokes the CreateClusterSecurityGroup operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSClusterSecurityGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>New-RSClusterSecurityGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name for the security group. Amazon Redshift stores the value as a lowercase string. Constraints: - Must contain no more than 255 alphanumeric characters or hyphens. - Must not be "Default". - Must be unique for all security groups that are created by your AWS account. Example: <code>examplesecuritygroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Description</name> <description> <para>A description for the security group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name for the security group. Amazon Redshift stores the value as a lowercase string. Constraints: - Must contain no more than 255 alphanumeric characters or hyphens. - Must not be "Default". - Must be unique for all security groups that are created by your AWS account. Example: <code>examplesecuritygroup</code> </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="False" position="2"> <name>Description</name> <description> <para>A description for the security group. </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="False" 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="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.ClusterSecurityGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ClusterSecurityGroup object. The service call response (type Amazon.Redshift.Model.CreateClusterSecurityGroupResponse) 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=New-RSClusterSecurityGroup.html&tocid=New-RSClusterSecurityGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSClusterSnapshot</name> <description> <para>Invokes the CreateClusterSnapshot operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a manual snapshot of the specified cluster. The cluster must be in the <code>available</code> state. For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>New-RSClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SnapshotIdentifier</name> <description> <para>A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 alphanumeric characters or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-snapshot-id</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>ClusterIdentifier</name> <description> <para>The cluster identifier for which you want a snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>ClusterIdentifier</name> <description> <para>The cluster identifier for which you want a snapshot. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>SnapshotIdentifier</name> <description> <para>A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 alphanumeric characters or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-snapshot-id</code> </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.Snapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Snapshot object. The service call response (type Amazon.Redshift.Model.CreateClusterSnapshotResponse) 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=New-RSClusterSnapshot.html&tocid=New-RSClusterSnapshot</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSClusterSubnetGroup</name> <description> <para>Invokes the CreateClusterSubnetGroup operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSClusterSubnetGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. For information about subnet groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html">Amazon Redshift Cluster Subnet Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>New-RSClusterSubnetGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSubnetGroupName</name> <description> <para>The name for the subnet group. Amazon Redshift stores the value as a lowercase string. Constraints: - Must contain no more than 255 alphanumeric characters or hyphens. - Must not be "Default". - Must be unique for all subnet groups that are created by your AWS account. Example: <code>examplesubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Description</name> <description> <para>A description for the subnet group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SubnetId</name> <description> <para>An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSubnetGroupName</name> <description> <para>The name for the subnet group. Amazon Redshift stores the value as a lowercase string. Constraints: - Must contain no more than 255 alphanumeric characters or hyphens. - Must not be "Default". - Must be unique for all subnet groups that are created by your AWS account. Example: <code>examplesubnetgroup</code> </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="False" position="2"> <name>Description</name> <description> <para>A description for the subnet group. </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="False" 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="False" position="3"> <name>SubnetId</name> <description> <para>An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.ClusterSubnetGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ClusterSubnetGroup object. The service call response (type Amazon.Redshift.Model.CreateClusterSubnetGroupResponse) 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=New-RSClusterSubnetGroup.html&tocid=New-RSClusterSubnetGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSEventSubscription</name> <description> <para>Invokes the CreateEventSubscription operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSEventSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID. </para> </description> <syntax> <syntaxItem> <name>New-RSEventSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para>A Boolean value; set to <code>true</code> to activate the subscription, set to <code>false</code> to create the subscription but not active it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para>Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: Configuration, Management, Monitoring, Security </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Severity</name> <description> <para>Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceId</name> <description> <para>A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010 </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SubscriptionName</name> <description> <para>The name of the event subscription to be created. Constraints: - Cannot be null, empty, or blank. - Must contain from 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para>A Boolean value; set to <code>true</code> to activate the subscription, set to <code>false</code> to create the subscription but not active it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para>Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: Configuration, Management, Monitoring, Security </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="False" 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="False" position="Named"> <name>Severity</name> <description> <para>Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO </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="False" position="Named"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </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="False" position="Named"> <name>SourceId</name> <description> <para>A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010 </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="False" position="Named"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot. </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>SubscriptionName</name> <description> <para>The name of the event subscription to be created. Constraints: - Cannot be null, empty, or blank. - Must contain from 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventSubscription object. The service call response (type Amazon.Redshift.Model.CreateEventSubscriptionResponse) 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=New-RSEventSubscription.html&tocid=New-RSEventSubscription</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSHsmClientCertificate</name> <description> <para>Invokes the CreateHsmClientCertificate operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSHsmClientCertificate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a> in the Amazon Redshift Cluster Management Guide. </para> </description> <syntax> <syntaxItem> <name>New-RSHsmClientCertificate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.HsmClientCertificate</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a HsmClientCertificate object. The service call response (type Amazon.Redshift.Model.CreateHsmClientCertificateResponse) 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=New-RSHsmClientCertificate.html&tocid=New-RSHsmClientCertificate</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSHsmConfiguration</name> <description> <para>Invokes the CreateHsmConfiguration operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSHsmConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a> in the Amazon Redshift Cluster Management Guide. </para> </description> <syntax> <syntaxItem> <name>New-RSHsmConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A text description of the HSM configuration to be created. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HsmConfigurationIdentifier</name> <description> <para>The identifier to be assigned to the new Amazon Redshift HSM configuration. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmIpAddress</name> <description> <para>The IP address that the Amazon Redshift cluster must use to access the HSM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmPartitionName</name> <description> <para>The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmPartitionPassword</name> <description> <para>The password required to access the HSM partition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmServerPublicCertificate</name> <description> <para>The HSMs public certificate file. When using Cloud HSM, the file name is server.pem. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A text description of the HSM configuration to be created. </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="False" 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>HsmConfigurationIdentifier</name> <description> <para>The identifier to be assigned to the new Amazon Redshift HSM configuration. </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="False" position="Named"> <name>HsmIpAddress</name> <description> <para>The IP address that the Amazon Redshift cluster must use to access the HSM. </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="False" position="Named"> <name>HsmPartitionName</name> <description> <para>The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys. </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="False" position="Named"> <name>HsmPartitionPassword</name> <description> <para>The password required to access the HSM partition. </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="False" position="Named"> <name>HsmServerPublicCertificate</name> <description> <para>The HSMs public certificate file. When using Cloud HSM, the file name is server.pem. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.HsmConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a HsmConfiguration object. The service call response (type Amazon.Redshift.Model.CreateHsmConfigurationResponse) 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=New-RSHsmConfiguration.html&tocid=New-RSHsmConfiguration</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSResourceTag</name> <description> <para>Invokes the CreateTags operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds one or more tags to a specified resource. A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail. If you specify a key that already exists for the resource, the value for that key will be updated with the new value. </para> </description> <syntax> <syntaxItem> <name>New-RSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceName</name> <description> <para>The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter <code>Key</code> and the corresponding value is passed in with the parameter <code>Value</code>. The <code>Key</code> and <code>Value</code> parameters are separated by a comma (,). Separate multiple tags with a space. For example, <code>--tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0"</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>ResourceName</name> <description> <para>The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </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="False" position="Named"> <name>Tag</name> <description> <para>One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter <code>Key</code> and the corresponding value is passed in with the parameter <code>Value</code>. The <code>Key</code> and <code>Value</code> parameters are separated by a comma (,). Separate multiple tags with a space. For example, <code>--tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0"</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.Redshift.Model.CreateTagsResponse) 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=New-RSResourceTag.html&tocid=New-RSResourceTag</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>New-RSSnapshotCopyGrant</name> <description> <para>Invokes the CreateSnapshotCopyGrant operation against Amazon Redshift.</para> </description> <verb>New</verb> <noun>RSSnapshotCopyGrant</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region. For more information about managing snapshot copy grants, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>New-RSSnapshotCopyGrant</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotCopyGrantName</name> <description> <para>The name of the snapshot copy grant. This name must be unique in the region for the AWS account. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used. </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="False" position="Named"> <name>SnapshotCopyGrantName</name> <description> <para>The name of the snapshot copy grant. This name must be unique in the region for the AWS account. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account. </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="False" position="Named"> <name>Tag</name> <description> <para>A list of tag instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Tag[]</parameterValue> <type> <name>Amazon.Redshift.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.SnapshotCopyGrant</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SnapshotCopyGrant object. The service call response (type Amazon.Redshift.Model.CreateSnapshotCopyGrantResponse) 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=New-RSSnapshotCopyGrant.html&tocid=New-RSSnapshotCopyGrant</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSCluster</name> <description> <para>Invokes the DeleteCluster operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use <a>DescribeClusters</a> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Remove-RSCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster to be deleted. Constraints: - Must contain lowercase characters. - Must contain from 1 to 63 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FinalClusterSnapshotIdentifier</name> <description> <para>The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>. Constraints: - Must be 1 to 255 alphanumeric characters. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SkipFinalClusterSnapshot</name> <description> <para>Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted. The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster to be deleted. Constraints: - Must contain lowercase characters. - Must contain from 1 to 63 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </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="False" position="Named"> <name>FinalClusterSnapshotIdentifier</name> <description> <para>The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>. Constraints: - Must be 1 to 255 alphanumeric characters. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </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="False" 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="False" position="Named"> <name>SkipFinalClusterSnapshot</name> <description> <para>Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted. The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.DeleteClusterResponse) 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=Remove-RSCluster.html&tocid=Remove-RSCluster</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSClusterParameterGroup</name> <description> <para>Invokes the DeleteClusterParameterGroup operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster. </para> </description> <syntax> <syntaxItem> <name>Remove-RSClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of the parameter group to be deleted. Constraints: - Must be the name of an existing cluster parameter group. - Cannot delete a default cluster parameter group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ParameterGroupName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of the parameter group to be deleted. Constraints: - Must be the name of an existing cluster parameter group. - Cannot delete a default cluster parameter group. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ParameterGroupName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ParameterGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Redshift.Model.DeleteClusterParameterGroupResponse) 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-RSClusterParameterGroup.html&tocid=Remove-RSClusterParameterGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSClusterSecurityGroup</name> <description> <para>Invokes the DeleteClusterSecurityGroup operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSClusterSecurityGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security group. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Remove-RSClusterSecurityGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name of the cluster security group to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ClusterSecurityGroupName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name of the cluster security group to be deleted. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ClusterSecurityGroupName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ClusterSecurityGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Redshift.Model.DeleteClusterSecurityGroupResponse) 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-RSClusterSecurityGroup.html&tocid=Remove-RSClusterSecurityGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSClusterSnapshot</name> <description> <para>Invokes the DeleteClusterSnapshot operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified manual snapshot. The snapshot must be in the <code>available</code> state, with no other users authorized to access the snapshot. Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot. </para> </description> <syntax> <syntaxItem> <name>Remove-RSClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SnapshotIdentifier</name> <description> <para>The unique identifier of the manual snapshot to be deleted. Constraints: Must be the name of an existing snapshot that is in the <code>available</code> state. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotClusterIdentifier</name> <description> <para>The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the name of valid cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>SnapshotClusterIdentifier</name> <description> <para>The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints: Must be the name of valid cluster. </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 (ByValue, ByPropertyName)" position="1"> <name>SnapshotIdentifier</name> <description> <para>The unique identifier of the manual snapshot to be deleted. Constraints: Must be the name of an existing snapshot that is in the <code>available</code> state. </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.Redshift.Model.Snapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Snapshot object. The service call response (type Amazon.Redshift.Model.DeleteClusterSnapshotResponse) 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=Remove-RSClusterSnapshot.html&tocid=Remove-RSClusterSnapshot</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSClusterSubnetGroup</name> <description> <para>Invokes the DeleteClusterSubnetGroup operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSClusterSubnetGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified cluster subnet group. </para> </description> <syntax> <syntaxItem> <name>Remove-RSClusterSubnetGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSubnetGroupName</name> <description> <para>The name of the cluster subnet group name to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ClusterSubnetGroupName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSubnetGroupName</name> <description> <para>The name of the cluster subnet group name to be deleted. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ClusterSubnetGroupName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ClusterSubnetGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Redshift.Model.DeleteClusterSubnetGroupResponse) 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-RSClusterSubnetGroup.html&tocid=Remove-RSClusterSubnetGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSEventSubscription</name> <description> <para>Invokes the DeleteEventSubscription operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSEventSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an Amazon Redshift event notification subscription. </para> </description> <syntax> <syntaxItem> <name>Remove-RSEventSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the Amazon Redshift event notification subscription to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SubscriptionName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SubscriptionName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the Amazon Redshift event notification subscription to be deleted. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SubscriptionName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Redshift.Model.DeleteEventSubscriptionResponse) 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-RSEventSubscription.html&tocid=Remove-RSEventSubscription</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSHsmClientCertificate</name> <description> <para>Invokes the DeleteHsmClientCertificate operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSHsmClientCertificate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified HSM client certificate. </para> </description> <syntax> <syntaxItem> <name>Remove-RSHsmClientCertificate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HsmClientCertificateIdentifier</name> <description> <para>The identifier of the HSM client certificate to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HsmClientCertificateIdentifier parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>HsmClientCertificateIdentifier</name> <description> <para>The identifier of the HSM client certificate to be deleted. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HsmClientCertificateIdentifier parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the HsmClientCertificateIdentifier parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Redshift.Model.DeleteHsmClientCertificateResponse) 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-RSHsmClientCertificate.html&tocid=Remove-RSHsmClientCertificate</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSHsmConfiguration</name> <description> <para>Invokes the DeleteHsmConfiguration operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSHsmConfiguration</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified Amazon Redshift HSM configuration. </para> </description> <syntax> <syntaxItem> <name>Remove-RSHsmConfiguration</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>HsmConfigurationIdentifier</name> <description> <para>The identifier of the Amazon Redshift HSM configuration to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HsmConfigurationIdentifier parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>HsmConfigurationIdentifier</name> <description> <para>The identifier of the Amazon Redshift HSM configuration to be deleted. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HsmConfigurationIdentifier parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the HsmConfigurationIdentifier parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Redshift.Model.DeleteHsmConfigurationResponse) 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-RSHsmConfiguration.html&tocid=Remove-RSHsmConfiguration</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSResourceTag</name> <description> <para>Invokes the DeleteTags operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. </para> </description> <syntax> <syntaxItem> <name>Remove-RSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceName</name> <description> <para>The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>The tag key that you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>ResourceName</name> <description> <para>The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </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="False" position="Named"> <name>TagKey</name> <description> <para>The tag key that you want to delete. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.Redshift.Model.DeleteTagsResponse) 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-RSResourceTag.html&tocid=Remove-RSResourceTag</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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-RSSnapshotCopyGrant</name> <description> <para>Invokes the DeleteSnapshotCopyGrant operation against Amazon Redshift.</para> </description> <verb>Remove</verb> <noun>RSSnapshotCopyGrant</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified snapshot copy grant. </para> </description> <syntax> <syntaxItem> <name>Remove-RSSnapshotCopyGrant</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SnapshotCopyGrantName</name> <description> <para>The name of the snapshot copy grant to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SnapshotCopyGrantName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SnapshotCopyGrantName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>SnapshotCopyGrantName</name> <description> <para>The name of the snapshot copy grant to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SnapshotCopyGrantName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Redshift.Model.DeleteSnapshotCopyGrantResponse) 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-RSSnapshotCopyGrant.html&tocid=Remove-RSSnapshotCopyGrant</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Request-RSReservedNodeOffering</name> <description> <para>Invokes the PurchaseReservedNodeOffering operation against Amazon Redshift.</para> </description> <verb>Request</verb> <noun>RSReservedNodeOffering</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the <a>DescribeReservedNodeOfferings</a> API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Request-RSReservedNodeOffering</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedNodeOfferingId</name> <description> <para>The unique identifier of the reserved node offering you want to purchase. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>NodeCount</name> <description> <para>The number of reserved nodes that you want to purchase. Default: <code>1</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>NodeCount</name> <description> <para>The number of reserved nodes that you want to purchase. Default: <code>1</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedNodeOfferingId</name> <description> <para>The unique identifier of the reserved node offering you want to purchase. </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.Redshift.Model.ReservedNode</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ReservedNode object. The service call response (type Amazon.Redshift.Model.PurchaseReservedNodeOfferingResponse) 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=Request-RSReservedNodeOffering.html&tocid=Request-RSReservedNodeOffering</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Reset-RSClusterParameterGroup</name> <description> <para>Invokes the ResetClusterParameterGroup operation against Amazon Redshift.</para> </description> <verb>Reset</verb> <noun>RSClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the <i>ResetAllParameters</i> parameter. For parameter changes to take effect you must reboot any associated clusters. </para> </description> <syntax> <syntaxItem> <name>Reset-RSClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of the cluster parameter group to be reset. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameter</name> <description> <para>An array of names of parameters to be reset. If <i>ResetAllParameters</i> option is not used, then at least one parameter name must be supplied. Constraints: A maximum of 20 parameters can be reset in a single request. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Parameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResetAllParameter</name> <description> <para>If <code>true</code>, all parameters in the specified parameter group will be reset to their default values. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Parameter</name> <description> <para>An array of names of parameters to be reset. If <i>ResetAllParameters</i> option is not used, then at least one parameter name must be supplied. Constraints: A maximum of 20 parameters can be reset in a single request. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Redshift.Model.Parameter[]</parameterValue> <type> <name>Amazon.Redshift.Model.Parameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ParameterGroupName</name> <description> <para>The name of the cluster parameter group to be reset. </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="False" position="Named"> <name>ResetAllParameter</name> <description> <para>If <code>true</code>, all parameters in the specified parameter group will be reset to their default values. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.ResetClusterParameterGroupResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Redshift.Model.ResetClusterParameterGroupResponse 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=Reset-RSClusterParameterGroup.html&tocid=Reset-RSClusterParameterGroup</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Restart-RSCluster</name> <description> <para>Invokes the RebootCluster operation against Amazon Redshift.</para> </description> <verb>Restart</verb> <noun>RSCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to <code>rebooting</code>. A cluster event is created when the reboot is completed. Any pending cluster modifications (see <a>ModifyCluster</a>) are applied at this reboot. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Restart-RSCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The cluster identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The cluster identifier. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.RebootClusterResponse) 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=Restart-RSCluster.html&tocid=Restart-RSCluster</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Restore-RSFromClusterSnapshot</name> <description> <para>Invokes the RestoreFromClusterSnapshot operation against Amazon Redshift.</para> </description> <verb>Restore</verb> <noun>RSFromClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the <a>ModifyCluster</a> API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Restore-RSFromClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster that will be created from restoring the snapshot. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>SnapshotIdentifier</name> <description> <para>The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. Example: <code>my-snapshot-id</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdditionalInfo</name> <description> <para>Reserved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowVersionUpgrade</name> <description> <para>If <code>true</code>, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutomatedSnapshotRetentionPeriod</name> <description> <para>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. Default: The value selected for the cluster from which the snapshot was taken. Constraints: Must be a value from 0 to 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The Amazon EC2 Availability Zone in which to restore the cluster. Default: A random, system-chosen Availability Zone. Example: <code>us-east-1a</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClusterParameterGroupName</name> <description> <para>The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon Redshift Parameter Groups</a>. Constraints: - Must be 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClusterSecurityGroup</name> <description> <para>A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. Cluster security groups only apply to clusters outside of VPCs. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ClusterSubnetGroupName</name> <description> <para>The name of the subnet group where you want to cluster restored. A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The elastic IP (EIP) address for the cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnhancedVpcRouting</name> <description> <para>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide. If this option is <code>true</code>, enhanced VPC routing is enabled. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>HsmConfigurationIdentifier</name> <description> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IamRole</name> <description> <para>A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated at any time. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NodeType</name> <description> <para>The node type that the restored cluster will be provisioned with. Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes"> About Clusters and Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OwnerAccount</name> <description> <para>The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the cluster accepts connections. Default: The same port as the original cluster. Constraints: Must be between <code>1115</code> and <code>65535</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows">Maintenance Windows</a> in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>If <code>true</code>, the cluster can be accessed from a public network. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotClusterIdentifier</name> <description> <para>The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. VPC security groups only apply to clusters in VPCs. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AdditionalInfo</name> <description> <para>Reserved. </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="False" position="Named"> <name>AllowVersionUpgrade</name> <description> <para>If <code>true</code>, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutomatedSnapshotRetentionPeriod</name> <description> <para>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. Default: The value selected for the cluster from which the snapshot was taken. Constraints: Must be a value from 0 to 35. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The Amazon EC2 Availability Zone in which to restore the cluster. Default: A random, system-chosen Availability Zone. Example: <code>us-east-1a</code> </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 (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the cluster that will be created from restoring the snapshot. Constraints: - Must contain from 1 to 63 alphanumeric characters or hyphens. - Alphabetic characters must be lowercase. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. - Must be unique for all clusters within an AWS account. </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="False" position="Named"> <name>ClusterParameterGroupName</name> <description> <para>The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon Redshift Parameter Groups</a>. Constraints: - Must be 1 to 255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. </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="False" position="Named"> <name>ClusterSecurityGroup</name> <description> <para>A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. Cluster security groups only apply to clusters outside of VPCs. </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>ClusterSubnetGroupName</name> <description> <para>The name of the subnet group where you want to cluster restored. A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored. </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="False" position="Named"> <name>ElasticIp</name> <description> <para>The elastic IP (EIP) address for the cluster. </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="False" position="Named"> <name>EnhancedVpcRouting</name> <description> <para>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide. If this option is <code>true</code>, enhanced VPC routing is enabled. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>HsmClientCertificateIdentifier</name> <description> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. </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>HsmConfigurationIdentifier</name> <description> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. </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="False" position="Named"> <name>IamRole</name> <description> <para>A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated at any time. </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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot. </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="False" position="Named"> <name>NodeType</name> <description> <para>The node type that the restored cluster will be provisioned with. Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes"> About Clusters and Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i> </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="False" position="Named"> <name>OwnerAccount</name> <description> <para>The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the cluster accepts connections. Default: The same port as the original cluster. Constraints: Must be between <code>1115</code> and <code>65535</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows">Maintenance Windows</a> in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window. </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="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>If <code>true</code>, the cluster can be accessed from a public network. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotClusterIdentifier</name> <description> <para>The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </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="2"> <name>SnapshotIdentifier</name> <description> <para>The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. Example: <code>my-snapshot-id</code> </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="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. VPC security groups only apply to clusters in VPCs. </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.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.RestoreFromClusterSnapshotResponse) 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=Restore-RSFromClusterSnapshot.html&tocid=Restore-RSFromClusterSnapshot</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Restore-RSTableFromClusterSnapshot</name> <description> <para>Invokes the RestoreTableFromClusterSnapshot operation against Amazon Redshift.</para> </description> <verb>Restore</verb> <noun>RSTableFromClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use <code>RestoreTableFromClusterSnapshot</code> to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call <code>RestoreTableFromClusterSnapshot</code>. When you have renamed your original table, then you can pass the original name of the table as the <code>NewTableName</code> parameter value in the call to <code>RestoreTableFromClusterSnapshot</code>. This way, you can replace the original table with the table created from the snapshot. </para> </description> <syntax> <syntaxItem> <name>Restore-RSTableFromClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the Amazon Redshift cluster to restore the table to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NewTableName</name> <description> <para>The name of the table to create as a result of the current request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SnapshotIdentifier</name> <description> <para>The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the <code>ClusterIdentifier</code> parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceDatabaseName</name> <description> <para>The name of the source database that contains the table to restore from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceSchemaName</name> <description> <para>The name of the source schema that contains the table to restore from. If you do not specify a <code>SourceSchemaName</code> value, the default is <code>public</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceTableName</name> <description> <para>The name of the source table to restore from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetDatabaseName</name> <description> <para>The name of the database to restore the table to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetSchemaName</name> <description> <para>The name of the schema to restore the table to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The identifier of the Amazon Redshift cluster to restore the table to. </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="False" 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="False" position="Named"> <name>NewTableName</name> <description> <para>The name of the table to create as a result of the current request. </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>SnapshotIdentifier</name> <description> <para>The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the <code>ClusterIdentifier</code> parameter. </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="False" position="Named"> <name>SourceDatabaseName</name> <description> <para>The name of the source database that contains the table to restore from. </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="False" position="Named"> <name>SourceSchemaName</name> <description> <para>The name of the source schema that contains the table to restore from. If you do not specify a <code>SourceSchemaName</code> value, the default is <code>public</code>. </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="False" position="Named"> <name>SourceTableName</name> <description> <para>The name of the source table to restore from. </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="False" position="Named"> <name>TargetDatabaseName</name> <description> <para>The name of the database to restore the table to. </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="False" position="Named"> <name>TargetSchemaName</name> <description> <para>The name of the schema to restore the table to. </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.Redshift.Model.TableRestoreStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TableRestoreStatus object. The service call response (type Amazon.Redshift.Model.RestoreTableFromClusterSnapshotResponse) 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=Restore-RSTableFromClusterSnapshot.html&tocid=Restore-RSTableFromClusterSnapshot</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Revoke-RSClusterSecurityGroupIngress</name> <description> <para>Invokes the RevokeClusterSecurityGroupIngress operation against Amazon Redshift.</para> </description> <verb>Revoke</verb> <noun>RSClusterSecurityGroupIngress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see <a>AuthorizeClusterSecurityGroupIngress</a>. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Revoke-RSClusterSecurityGroupIngress</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name of the security Group from which to revoke the ingress rule. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>CIDRIP</name> <description> <para>The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If <code>CIDRIP</code> is specified, <code>EC2SecurityGroupName</code> and <code>EC2SecurityGroupOwnerId</code> cannot be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>EC2SecurityGroupName</name> <description> <para>The name of the EC2 Security Group whose access is to be revoked. If <code>EC2SecurityGroupName</code> is specified, <code>EC2SecurityGroupOwnerId</code> must also be provided and <code>CIDRIP</code> cannot be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <name>EC2SecurityGroupOwnerId</name> <description> <para>The AWS account number of the owner of the security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS access key ID is not an acceptable value. If <code>EC2SecurityGroupOwnerId</code> is specified, <code>EC2SecurityGroupName</code> must also be provided. and <code>CIDRIP</code> cannot be provided. Example: <code>111122223333</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>CIDRIP</name> <description> <para>The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If <code>CIDRIP</code> is specified, <code>EC2SecurityGroupName</code> and <code>EC2SecurityGroupOwnerId</code> cannot be provided. </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 (ByValue, ByPropertyName)" position="1"> <name>ClusterSecurityGroupName</name> <description> <para>The name of the security Group from which to revoke the ingress rule. </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="3"> <name>EC2SecurityGroupName</name> <description> <para>The name of the EC2 Security Group whose access is to be revoked. If <code>EC2SecurityGroupName</code> is specified, <code>EC2SecurityGroupOwnerId</code> must also be provided and <code>CIDRIP</code> cannot be provided. </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="4"> <name>EC2SecurityGroupOwnerId</name> <description> <para>The AWS account number of the owner of the security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS access key ID is not an acceptable value. If <code>EC2SecurityGroupOwnerId</code> is specified, <code>EC2SecurityGroupName</code> must also be provided. and <code>CIDRIP</code> cannot be provided. Example: <code>111122223333</code> </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.ClusterSecurityGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ClusterSecurityGroup object. The service call response (type Amazon.Redshift.Model.RevokeClusterSecurityGroupIngressResponse) 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=Revoke-RSClusterSecurityGroupIngress.html&tocid=Revoke-RSClusterSecurityGroupIngress</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Revoke-RSSnapshotAccess</name> <description> <para>Invokes the RevokeSnapshotAccess operation against Amazon Redshift.</para> </description> <verb>Revoke</verb> <noun>RSSnapshotAccess</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </description> <syntax> <syntaxItem> <name>Revoke-RSSnapshotAccess</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SnapshotIdentifier</name> <description> <para>The identifier of the snapshot that the account can no longer access. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AccountWithRestoreAccess</name> <description> <para>The identifier of the AWS customer account that can no longer restore the specified snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotClusterIdentifier</name> <description> <para>The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>AccountWithRestoreAccess</name> <description> <para>The identifier of the AWS customer account that can no longer restore the specified snapshot. </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="False" 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="False" position="Named"> <name>SnapshotClusterIdentifier</name> <description> <para>The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </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 (ByValue, ByPropertyName)" position="1"> <name>SnapshotIdentifier</name> <description> <para>The identifier of the snapshot that the account can no longer access. </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.Redshift.Model.Snapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Snapshot object. The service call response (type Amazon.Redshift.Model.RevokeSnapshotAccessResponse) 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=Revoke-RSSnapshotAccess.html&tocid=Revoke-RSSnapshotAccess</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Switch-RSEncryptionKey</name> <description> <para>Invokes the RotateEncryptionKey operation against Amazon Redshift.</para> </description> <verb>Switch</verb> <noun>RSEncryptionKey</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Rotates the encryption keys for a cluster. </para> </description> <syntax> <syntaxItem> <name>Switch-RSEncryptionKey</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster that you want to rotate the encryption keys for. Constraints: Must be the name of valid cluster that has encryption enabled. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ClusterIdentifier</name> <description> <para>The unique identifier of the cluster that you want to rotate the encryption keys for. Constraints: Must be the name of valid cluster that has encryption enabled. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Redshift.Model.Cluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.RotateEncryptionKeyResponse) 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=Switch-RSEncryptionKey.html&tocid=Switch-RSEncryptionKey</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/redshift/latest/APIReference/</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>Add-RDSRoleToDBCluster</name> <description> <para>Invokes the AddRoleToDBCluster operation against Amazon Relational Database Service.</para> </description> <verb>Add</verb> <noun>RDSRoleToDBCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Authorizing.AWSServices.html">Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf</a>. </para> </description> <syntax> <syntaxItem> <name>Add-RDSRoleToDBCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the DB cluster to associate the IAM role with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example <code>arn:aws:iam::123456789012:role/AuroraAccessRole</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBClusterIdentifier parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the DB cluster to associate the IAM role with. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBClusterIdentifier parameter. By default, this cmdlet does not generate any output. </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="False" position="2"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example <code>arn:aws:iam::123456789012:role/AuroraAccessRole</code>. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DBClusterIdentifier parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.AddRoleToDBClusterResponse) 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=Add-RDSRoleToDBCluster.html&tocid=Add-RDSRoleToDBCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Add-RDSSourceIdentifierToSubscription</name> <description> <para>Invokes the AddSourceIdentifierToSubscription operation against Amazon Relational Database Service.</para> </description> <verb>Add</verb> <noun>RDSSourceIdentifierToSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds a source identifier to an existing RDS event notification subscription. </para> </description> <syntax> <syntaxItem> <name>Add-RDSSourceIdentifierToSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription you want to add a source identifier to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>SourceIdentifier</name> <description> <para>The identifier of the event source to be added. Constraints: - If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied. - If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied. - If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied. - If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="2"> <name>SourceIdentifier</name> <description> <para>The identifier of the event source to be added. Constraints: - If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied. - If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied. - If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied. - If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied. </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 (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription you want to add a source identifier to. </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.RDS.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventSubscription object. The service call response (type Amazon.RDS.Model.AddSourceIdentifierToSubscriptionResponse) 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=Add-RDSSourceIdentifierToSubscription.html&tocid=Add-RDSSourceIdentifierToSubscription</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Add-RDSTagsToResource</name> <description> <para>Invokes the AddTagsToResource operation against Amazon Relational Database Service.</para> </description> <verb>Add</verb> <noun>RDSTagsToResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. For an overview on tagging Amazon RDS resources, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </description> <syntax> <syntaxItem> <name>Add-RDSTagsToResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceName</name> <description> <para>The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Tag</name> <description> <para>The tags to be assigned to the Amazon RDS resource. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the collection of tags that were added. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the collection of tags that were added. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>ResourceName</name> <description> <para>The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. </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="False" position="2"> <name>Tag</name> <description> <para>The tags to be assigned to the Amazon RDS resource. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.RDS.Model.Tag</name> <uri /> <description /> </type> <description> <para>Returns the collection of tags that were added when you use the PassThru parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.AddTagsToResourceResponse) 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=Add-RDSTagsToResource.html&tocid=Add-RDSTagsToResource</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Convert-RDSReadReplicaDBCluster</name> <description> <para>Invokes the PromoteReadReplicaDBCluster operation against Amazon Relational Database Service.</para> </description> <verb>Convert</verb> <noun>RDSReadReplicaDBCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Promotes a Read Replica DB cluster to a standalone DB cluster. </para> </description> <syntax> <syntaxItem> <name>Convert-RDSReadReplicaDBCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive. Constraints: - Must match the identifier of an existing DBCluster Read Replica. Example: <code>my-cluster-replica1</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive. Constraints: - Must match the identifier of an existing DBCluster Read Replica. Example: <code>my-cluster-replica1</code> </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBCluster object. The service call response (type Amazon.RDS.Model.PromoteReadReplicaDBClusterResponse) 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=Convert-RDSReadReplicaDBCluster.html&tocid=Convert-RDSReadReplicaDBCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Convert-RDSReadReplicaToStandalone</name> <description> <para>Invokes the PromoteReadReplica operation against Amazon Relational Database Service.</para> </description> <verb>Convert</verb> <noun>RDSReadReplicaToStandalone</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Promotes a Read Replica DB instance to a standalone DB instance. We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings. </para> </description> <syntax> <syntaxItem> <name>Convert-RDSReadReplicaToStandalone</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier. This value is stored as a lowercase string. Constraints: - Must match the identifier of an existing Read Replica DB instance. Example: <code>mydbinstance</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: - Must be a value from 0 to 8 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para> The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: - Must be a value from 0 to 8 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier. This value is stored as a lowercase string. Constraints: - Must match the identifier of an existing Read Replica DB instance. Example: <code>mydbinstance</code> </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="False" 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="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para> The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </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.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.PromoteReadReplicaResponse) 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=Convert-RDSReadReplicaToStandalone.html&tocid=Convert-RDSReadReplicaToStandalone</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Copy-RDSDBClusterParameterGroup</name> <description> <para>Invokes the CopyDBClusterParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>Copy</verb> <noun>RDSDBClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Copies the specified DB cluster parameter group. </para> </description> <syntax> <syntaxItem> <name>Copy-RDSDBClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceDBClusterParameterGroupIdentifier</name> <description> <para>The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. Constraints: - Must specify a valid DB cluster parameter group. - If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example <code>my-db-cluster-param-group</code>, or a valid ARN. - If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example <code>arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetDBClusterParameterGroupDescription</name> <description> <para>A description for the copied DB cluster parameter group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetDBClusterParameterGroupIdentifier</name> <description> <para>The identifier for the copied DB cluster parameter group. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-cluster-param-group1</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>SourceDBClusterParameterGroupIdentifier</name> <description> <para>The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. Constraints: - Must specify a valid DB cluster parameter group. - If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example <code>my-db-cluster-param-group</code>, or a valid ARN. - If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example <code>arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1</code>. </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetDBClusterParameterGroupDescription</name> <description> <para>A description for the copied DB cluster parameter group. </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="False" position="Named"> <name>TargetDBClusterParameterGroupIdentifier</name> <description> <para>The identifier for the copied DB cluster parameter group. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-cluster-param-group1</code> </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.RDS.Model.DBClusterParameterGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBClusterParameterGroup object. The service call response (type Amazon.RDS.Model.CopyDBClusterParameterGroupResponse) 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=Copy-RDSDBClusterParameterGroup.html&tocid=Copy-RDSDBClusterParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Copy-RDSDBClusterSnapshot</name> <description> <para>Invokes the CopyDBClusterSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>Copy</verb> <noun>RDSDBClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the <code>CopyDBClusterSnapshot</code> action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: - <code>KmsKeyId</code> - The AWS Key Management System (KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. - <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> action to be called in the source AWS Region where the DB cluster snapshot will be copied from. The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL. - <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in. - <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html"> Signature Version 4 Signing Process</a>. - <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. - <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the <code>SourceDBClusterSnapshotIdentifier</code> in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBClusterSnapshot.CrossRegion"> Copying a DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions</a> in the Amazon RDS User Guide. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Copy-RDSDBClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceDBClusterSnapshotIdentifier</name> <description> <para>The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. You cannot copy an encrypted, shared DB cluster snapshot from one AWS Region to another. Constraints: - Must specify a valid system snapshot in the "available" state. - If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. - If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html"> Copying a DB Snapshot or DB Cluster Snapshot</a>. Example: <code>my-cluster-snapshot1</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetDBClusterSnapshotIdentifier</name> <description> <para>The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>my-cluster-snapshot2</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTag</name> <description> <para>True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>. To copy an encrypted DB cluster snapshot to another AWS Region, you must set <code>KmsKeyId</code> to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreSignedUrl</name> <description> <para>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source DB cluster snapshot to copy. The <code>PreSignedUrl</code> parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. The pre-signed URL must be a valid request for the <code>CopyDBSClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL. - <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in. - <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html"> Signature Version 4 Signing Process</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceRegion</name> <description> <para> The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTag</name> <description> <para>True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>. To copy an encrypted DB cluster snapshot to another AWS Region, you must set <code>KmsKeyId</code> to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region. </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="False" position="Named"> <name>PreSignedUrl</name> <description> <para>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source DB cluster snapshot to copy. The <code>PreSignedUrl</code> parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. The pre-signed URL must be a valid request for the <code>CopyDBSClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL. - <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in. - <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html"> Signature Version 4 Signing Process</a>. </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 (ByValue, )" position="1"> <name>SourceDBClusterSnapshotIdentifier</name> <description> <para>The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. You cannot copy an encrypted, shared DB cluster snapshot from one AWS Region to another. Constraints: - Must specify a valid system snapshot in the "available" state. - If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. - If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html"> Copying a DB Snapshot or DB Cluster Snapshot</a>. Example: <code>my-cluster-snapshot1</code> </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="False" position="Named"> <name>SourceRegion</name> <description> <para> The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetDBClusterSnapshotIdentifier</name> <description> <para>The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>my-cluster-snapshot2</code> </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.RDS.Model.DBClusterSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBClusterSnapshot object. The service call response (type Amazon.RDS.Model.CopyDBClusterSnapshotResponse) 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=Copy-RDSDBClusterSnapshot.html&tocid=Copy-RDSDBClusterSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Copy-RDSDBParameterGroup</name> <description> <para>Invokes the CopyDBParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>Copy</verb> <noun>RDSDBParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Copies the specified DB parameter group. </para> </description> <syntax> <syntaxItem> <name>Copy-RDSDBParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceDBParameterGroupIdentifier</name> <description> <para> The identifier or ARN for the source DB parameter group. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. Constraints: - Must specify a valid DB parameter group. - Must specify a valid DB parameter group identifier, for example <code>my-db-param-group</code>, or a valid ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetDBParameterGroupIdentifier</name> <description> <para>The identifier for the copied DB parameter group. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-db-parameter-group</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>TargetDBParameterGroupDescription</name> <description> <para>A description for the copied DB parameter group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>SourceDBParameterGroupIdentifier</name> <description> <para> The identifier or ARN for the source DB parameter group. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. Constraints: - Must specify a valid DB parameter group. - Must specify a valid DB parameter group identifier, for example <code>my-db-param-group</code>, or a valid ARN. </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>TargetDBParameterGroupDescription</name> <description> <para>A description for the copied DB parameter group. </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="False" position="2"> <name>TargetDBParameterGroupIdentifier</name> <description> <para>The identifier for the copied DB parameter group. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-db-parameter-group</code> </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.RDS.Model.DBParameterGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBParameterGroup object. The service call response (type Amazon.RDS.Model.CopyDBParameterGroupResponse) 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=Copy-RDSDBParameterGroup.html&tocid=Copy-RDSDBParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Copy-RDSDBSnapshot</name> <description> <para>Invokes the CopyDBSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>Copy</verb> <noun>RDSDBSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Copies the specified DB snapshot. The source DB snapshot must be in the "available" state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the <code>CopyDBSnapshot</code> action is the destination AWS Region for the DB snapshot copy. You cannot copy an encrypted, shared DB snapshot from one AWS Region to another. For more information about copying snapshots, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopyDBSnapshot.html">Copying a DB Snapshot</a> in the Amazon RDS User Guide. </para> </description> <syntax> <syntaxItem> <name>Copy-RDSDBSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceDBSnapshotIdentifier</name> <description> <para>The identifier for the source DB snapshot. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify <code>rds:mysql-instance1-snapshot-20130805</code>. If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805</code>. If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the <code>SourceDBSnapshotIdentifier</code> in the <code>PreSignedUrl</code> parameter. Constraints: - Must specify a valid system snapshot in the "available" state. Example: <code>rds:mydb-2012-04-02-00-01</code> Example: <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetDBSnapshotIdentifier</name> <description> <para>The identifier for the copy of the snapshot. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-db-snapshot</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTag</name> <description> <para>True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across regions. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options">Option Group Considerations</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreSignedUrl</name> <description> <para>The URL that contains a Signature Version 4 signed request for the <code>CopyDBSnapshot</code> API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the source region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the <code>CopyDBSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: - <code>DestinationRegion</code> - The AWS Region that the encrypted DB snapshot will be copied to. This AWS Region is the same one where the <code>CopyDBSnapshot</code> action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 region to the us-east-1 region, then you call the <code>CopyDBSnapshot</code> action in the us-east-1 region and provide a presigned URL that contains a call to the <code>CopyDBSnapshot</code> action in the us-west-2 region. For this example, the <code>DestinationRegion</code> in the presigned URL must be set to the us-east-1 region. - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBSnapshot</code> action that is called in the destination AWS Region, and the action contained in the presigned URL. - <code>SourceDBSnapshotIdentifier</code> - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 region, then your <code>SourceDBSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceRegion</name> <description> <para> The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTag</name> <description> <para>True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region. </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>OptionGroupName</name> <description> <para>The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across regions. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options">Option Group Considerations</a>. </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="False" position="Named"> <name>PreSignedUrl</name> <description> <para>The URL that contains a Signature Version 4 signed request for the <code>CopyDBSnapshot</code> API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the source region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the <code>CopyDBSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: - <code>DestinationRegion</code> - The AWS Region that the encrypted DB snapshot will be copied to. This AWS Region is the same one where the <code>CopyDBSnapshot</code> action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 region to the us-east-1 region, then you call the <code>CopyDBSnapshot</code> action in the us-east-1 region and provide a presigned URL that contains a call to the <code>CopyDBSnapshot</code> action in the us-west-2 region. For this example, the <code>DestinationRegion</code> in the presigned URL must be set to the us-east-1 region. - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBSnapshot</code> action that is called in the destination AWS Region, and the action contained in the presigned URL. - <code>SourceDBSnapshotIdentifier</code> - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 region, then your <code>SourceDBSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </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 (ByValue, )" position="1"> <name>SourceDBSnapshotIdentifier</name> <description> <para>The identifier for the source DB snapshot. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify <code>rds:mysql-instance1-snapshot-20130805</code>. If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805</code>. If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the <code>SourceDBSnapshotIdentifier</code> in the <code>PreSignedUrl</code> parameter. Constraints: - Must specify a valid system snapshot in the "available" state. Example: <code>rds:mydb-2012-04-02-00-01</code> Example: <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805</code> </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="False" position="Named"> <name>SourceRegion</name> <description> <para> The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetDBSnapshotIdentifier</name> <description> <para>The identifier for the copy of the snapshot. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-db-snapshot</code> </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.RDS.Model.DBSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSnapshot object. The service call response (type Amazon.RDS.Model.CopyDBSnapshotResponse) 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=Copy-RDSDBSnapshot.html&tocid=Copy-RDSDBSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Copy-RDSOptionGroup</name> <description> <para>Invokes the CopyOptionGroup operation against Amazon Relational Database Service.</para> </description> <verb>Copy</verb> <noun>RDSOptionGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Copies the specified option group. </para> </description> <syntax> <syntaxItem> <name>Copy-RDSOptionGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceOptionGroupIdentifier</name> <description> <para>The identifier or ARN for the source option group. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. Constraints: - Must specify a valid option group. - If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for example <code>my-option-group</code>, or a valid ARN. - If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for example <code>arn:aws:rds:us-west-2:123456789012:og:special-options</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetOptionGroupIdentifier</name> <description> <para>The identifier for the copied option group. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-option-group</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>TargetOptionGroupDescription</name> <description> <para>The description for the copied option group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>SourceOptionGroupIdentifier</name> <description> <para>The identifier or ARN for the source option group. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. Constraints: - Must specify a valid option group. - If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for example <code>my-option-group</code>, or a valid ARN. - If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for example <code>arn:aws:rds:us-west-2:123456789012:og:special-options</code>. </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>TargetOptionGroupDescription</name> <description> <para>The description for the copied option group. </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="False" position="2"> <name>TargetOptionGroupIdentifier</name> <description> <para>The identifier for the copied option group. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-option-group</code> </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.RDS.Model.OptionGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a OptionGroup object. The service call response (type Amazon.RDS.Model.CopyOptionGroupResponse) 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=Copy-RDSOptionGroup.html&tocid=Copy-RDSOptionGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSDBCluster</name> <description> <para>Invokes the ModifyDBCluster operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSDBCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Edit-RDSDBCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApplyImmediately</name> <description> <para>A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB cluster. If this parameter is set to <code>false</code>, changes to the DB cluster are applied during the next maintenance window. The <code>ApplyImmediately</code> parameter only affects the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set the <code>ApplyImmediately</code> parameter value to false, then changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: - Must be a value from 1 to 35 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: - Must match the identifier of an existing DBCluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group to use for the DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NewDBClusterIdentifier</name> <description> <para>The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens - The first character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-cluster2</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the DB cluster accepts connections. Constraints: Value must be <code>1150-65535</code> Default: The same port as the original DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of VPC security groups that the DB cluster will belong to. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApplyImmediately</name> <description> <para>A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB cluster. If this parameter is set to <code>false</code>, changes to the DB cluster are applied during the next maintenance window. The <code>ApplyImmediately</code> parameter only affects the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set the <code>ApplyImmediately</code> parameter value to false, then changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: - Must be a value from 1 to 35 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: - Must match the identifier of an existing DBCluster. </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="False" position="Named"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group to use for the DB cluster. </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. </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="False" position="Named"> <name>NewDBClusterIdentifier</name> <description> <para>The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens - The first character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-cluster2</code> </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>OptionGroupName</name> <description> <para>A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster. </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the DB cluster accepts connections. Constraints: Value must be <code>1150-65535</code> Default: The same port as the original DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </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="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. </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="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of VPC security groups that the DB cluster will belong to. </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.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBCluster object. The service call response (type Amazon.RDS.Model.ModifyDBClusterResponse) 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=Edit-RDSDBCluster.html&tocid=Edit-RDSDBCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSDBClusterParameterGroup</name> <description> <para>Invokes the ModifyDBClusterParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSDBClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. <important><para> After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified. </para></important> </para> </description> <syntax> <syntaxItem> <name>Edit-RDSDBClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Parameter</name> <description> <para>A list of parameters in the DB cluster parameter group to modify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Parameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group to modify. </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="False" 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="False" position="2"> <name>Parameter</name> <description> <para>A list of parameters in the DB cluster parameter group to modify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Parameter[]</parameterValue> <type> <name>Amazon.RDS.Model.Parameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.RDS.Model.ModifyDBClusterParameterGroupResponse) 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=Edit-RDSDBClusterParameterGroup.html&tocid=Edit-RDSDBClusterParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSDBClusterSnapshotAttribute</name> <description> <para>Invokes the ModifyDBClusterSnapshotAttribute operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSDBClusterSnapshotAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify <code>restore</code> as the <code>AttributeName</code> and use the <code>ValuesToAdd</code> parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value <code>all</code> to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the <code>all</code> value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the <code>ValuesToAdd</code> parameter. You can't use <code>all</code> as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API action. </para> </description> <syntax> <syntaxItem> <name>Edit-RDSDBClusterSnapshotAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeName</name> <description> <para>The name of the DB cluster snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to <code>restore</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterSnapshotIdentifier</name> <description> <para>The identifier for the DB cluster snapshot to modify the attributes for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ValuesToAdd</name> <description> <para>A list of DB cluster snapshot attributes to add to the attribute specified by <code>AttributeName</code>. To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or <code>all</code> to make the manual DB cluster snapshot restorable by any AWS account. Do not add the <code>all</code> value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ValuesToRemove</name> <description> <para>A list of DB cluster snapshot attributes to remove from the attribute specified by <code>AttributeName</code>. To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or <code>all</code> to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify <code>all</code>, an AWS account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore a manual DB cluster snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeName</name> <description> <para>The name of the DB cluster snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to <code>restore</code>. </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="False" position="Named"> <name>DBClusterSnapshotIdentifier</name> <description> <para>The identifier for the DB cluster snapshot to modify the attributes for. </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="False" 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="False" position="Named"> <name>ValuesToAdd</name> <description> <para>A list of DB cluster snapshot attributes to add to the attribute specified by <code>AttributeName</code>. To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or <code>all</code> to make the manual DB cluster snapshot restorable by any AWS account. Do not add the <code>all</code> value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. </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="False" position="Named"> <name>ValuesToRemove</name> <description> <para>A list of DB cluster snapshot attributes to remove from the attribute specified by <code>AttributeName</code>. To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or <code>all</code> to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify <code>all</code>, an AWS account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore a manual DB cluster snapshot. </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.RDS.Model.DBClusterSnapshotAttributesResult</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBClusterSnapshotAttributesResult object. The service call response (type Amazon.RDS.Model.ModifyDBClusterSnapshotAttributeResponse) 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=Edit-RDSDBClusterSnapshotAttribute.html&tocid=Edit-RDSDBClusterSnapshotAttribute</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSDBInstance</name> <description> <para>Invokes the ModifyDBInstance operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSDBInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call <a>DescribeValidDBInstanceModifications</a> before you call <a>ModifyDBInstance</a>. </para> </description> <syntax> <syntaxItem> <name>Edit-RDSDBInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier. This value is stored as a lowercase string. Constraints: - Must match the identifier of an existing DBInstance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllocatedStorage</name> <description> <para> The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless <code>ApplyImmediately</code> is set to <code>true</code> for this request. <b>MySQL</b> Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer <b>MariaDB</b> Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer <b>PostgreSQL</b> Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer <b>Oracle</b> Default: Uses existing setting Valid Values: 10-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. <b>SQL Server</b> Cannot be modified. If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowMajorVersionUpgrade</name> <description> <para>Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApplyImmediately</name> <description> <para>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. If this parameter is set to <code>false</code>, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to <a>RebootDBInstance</a>, or the next failure reboot. Review the table of parameters in <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html">Modifying a DB Instance and Using the Apply Immediately Parameter</a> to see the impact that setting <code>ApplyImmediately</code> to <code>true</code> or <code>false</code> has for each modified parameter and to determine when the changes will be applied. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para> Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. <b>Amazon Aurora</b> Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. Default: Uses existing setting Constraints: - Must be a value from 0 to 35 - Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 - Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5 - Cannot be set to 0 if the DB instance is a source to Read Replicas </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CACertificateIdentifier</name> <description> <para>Indicates the certificate that needs to be associated with the instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para> The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the <a>DescribeOrderableDBInstanceOptions</a> action. Note that not all instance classes are available in all regions for all DB engines. Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless <code>ApplyImmediately</code> is specified as <code>true</code> for this request. Default: Uses existing setting Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBPortNumber</name> <description> <para>The port number on which the database accepts connections. The value of the <code>DBPortNumber</code> parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the <code>DBPortNumber</code> value regardless of the value of the <code>ApplyImmediately</code> parameter. <b>MySQL</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> <b>MariaDB</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> <b>PostgreSQL</b> Default: <code>5432</code> Valid Values: <code>1150-65535</code> Type: Integer <b>Oracle</b> Default: <code>1521</code> Valid Values: <code>1150-65535</code> <b>SQL Server</b> Default: <code>1433</code> Valid Values: <code>1150-65535</code> except for <code>1434</code>, <code>3389</code>, <code>47001</code>, <code>49152</code>, and <code>49152</code> through <code>49156</code>. <b>Amazon Aurora</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBSecurityGroup</name> <description> <para>A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: - If supplied, must match existing DBSecurityGroups. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC">Updating the VPC for a DB Instance</a>. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify <code>true</code> for the <code>ApplyImmediately</code> parameter. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetGroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Domain</name> <description> <para>The Active Directory Domain to move the instance to. Specify <code>none</code> to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DomainIAMRoleName</name> <description> <para>The name of the IAM role to use when making API calls to the Directory Service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines <b>Amazon Aurora</b> Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. <b>MySQL</b> - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnablePerformanceInsight</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineVersion</name> <description> <para> The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. For a list of valid engine versions, see <a>CreateDBInstance</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Iops</name> <description> <para> The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. Default: Uses existing setting Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect. <b>SQL Server</b> Setting the IOPS value for the SQL Server database engine is not supported. Type: Integer If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>The license model for the DB instance. Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The new password for the master user. Can be any printable ASCII character except "/", """, or "@". Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. <b>Amazon Aurora</b> Not applicable. The password for the master user is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. Default: Uses existing setting <b>MariaDB</b> Constraints: Must contain from 8 to 41 characters. <b>Microsoft SQL Server</b> Constraints: Must contain from 8 to 128 characters. <b>MySQL</b> Constraints: Must contain from 8 to 41 characters. <b>Oracle</b> Constraints: Must contain from 8 to 30 characters. <b>PostgreSQL</b> Constraints: Must contain from 8 to 128 characters. Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringInterval</name> <description> <para>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0. Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringRoleArn</name> <description> <para>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To create an IAM role for Amazon RDS Enhanced Monitoring</a>. If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MultiAZ</name> <description> <para> Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. Constraints: Cannot be specified if the DB instance is a Read Replica. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NewDBInstanceIdentifier</name> <description> <para> The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set <code>Apply Immediately</code> to true, or will occur during the next maintenance window if <code>Apply Immediately</code> to false. This value is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - The first character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>mydbinstance</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para> Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PerformanceInsightsKMSKeyId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para> The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code> parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. <b>Amazon Aurora</b> Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. Constraints: - Must be in the format hh24:mi-hh24:mi - Times should be in Universal Time Coordinated (UTC) - Must not conflict with the preferred maintenance window - Must be at least 30 minutes </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PromotionTier</name> <description> <para>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance"> Fault Tolerance for an Aurora DB Cluster</a>. Default: 1 Valid Values: 0 - 15 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to <code>True</code> to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to <code>False</code> to make the DB instance internal with a DNS name that resolves to a private IP address. <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a public subnet and <code>PubliclyAccessible</code> must be true in order for it to be publicly accessible. Changes to the <code>PubliclyAccessible</code> parameter are applied immediately regardless of the value of the <code>ApplyImmediately</code> parameter. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the DB instance. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialArn</name> <description> <para>The ARN from the Key Store with which to associate the instance for TDE encryption. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialPassword</name> <description> <para>The password for the given ARN from the Key Store in order to access the device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. <b>Amazon Aurora</b> Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. Constraints: - If supplied, must match existing VpcSecurityGroupIds. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllocatedStorage</name> <description> <para> The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless <code>ApplyImmediately</code> is set to <code>true</code> for this request. <b>MySQL</b> Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer <b>MariaDB</b> Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer <b>PostgreSQL</b> Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer <b>Oracle</b> Default: Uses existing setting Valid Values: 10-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. <b>SQL Server</b> Cannot be modified. If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowMajorVersionUpgrade</name> <description> <para>Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApplyImmediately</name> <description> <para>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. If this parameter is set to <code>false</code>, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to <a>RebootDBInstance</a>, or the next failure reboot. Review the table of parameters in <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html">Modifying a DB Instance and Using the Apply Immediately Parameter</a> to see the impact that setting <code>ApplyImmediately</code> to <code>true</code> or <code>false</code> has for each modified parameter and to determine when the changes will be applied. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para> Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. <b>Amazon Aurora</b> Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. Default: Uses existing setting Constraints: - Must be a value from 0 to 35 - Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 - Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5 - Cannot be set to 0 if the DB instance is a source to Read Replicas </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CACertificateIdentifier</name> <description> <para>Indicates the certificate that needs to be associated with the instance. </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="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para> The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the <a>DescribeOrderableDBInstanceOptions</a> action. Note that not all instance classes are available in all regions for all DB engines. Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless <code>ApplyImmediately</code> is specified as <code>true</code> for this request. Default: Uses existing setting Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> </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 (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier. This value is stored as a lowercase string. Constraints: - Must match the identifier of an existing DBInstance. </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>DBParameterGroupName</name> <description> <para>The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance. </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="False" position="Named"> <name>DBPortNumber</name> <description> <para>The port number on which the database accepts connections. The value of the <code>DBPortNumber</code> parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the <code>DBPortNumber</code> value regardless of the value of the <code>ApplyImmediately</code> parameter. <b>MySQL</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> <b>MariaDB</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> <b>PostgreSQL</b> Default: <code>5432</code> Valid Values: <code>1150-65535</code> Type: Integer <b>Oracle</b> Default: <code>1521</code> Valid Values: <code>1150-65535</code> <b>SQL Server</b> Default: <code>1433</code> Valid Values: <code>1150-65535</code> except for <code>1434</code>, <code>3389</code>, <code>47001</code>, <code>49152</code>, and <code>49152</code> through <code>49156</code>. <b>Amazon Aurora</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBSecurityGroup</name> <description> <para>A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: - If supplied, must match existing DBSecurityGroups. </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>DBSubnetGroupName</name> <description> <para>The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC">Updating the VPC for a DB Instance</a>. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify <code>true</code> for the <code>ApplyImmediately</code> parameter. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetGroup</code> </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="False" position="Named"> <name>Domain</name> <description> <para>The Active Directory Domain to move the instance to. Specify <code>none</code> to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain. </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="False" position="Named"> <name>DomainIAMRoleName</name> <description> <para>The name of the IAM role to use when making API calls to the Directory Service. </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines <b>Amazon Aurora</b> Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. <b>MySQL</b> - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnablePerformanceInsight</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineVersion</name> <description> <para> The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. For a list of valid engine versions, see <a>CreateDBInstance</a>. </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="False" 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="False" position="Named"> <name>Iops</name> <description> <para> The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. Default: Uses existing setting Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect. <b>SQL Server</b> Setting the IOPS value for the SQL Server database engine is not supported. Type: Integer If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>The license model for the DB instance. Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </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="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The new password for the master user. Can be any printable ASCII character except "/", """, or "@". Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. <b>Amazon Aurora</b> Not applicable. The password for the master user is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. Default: Uses existing setting <b>MariaDB</b> Constraints: Must contain from 8 to 41 characters. <b>Microsoft SQL Server</b> Constraints: Must contain from 8 to 128 characters. <b>MySQL</b> Constraints: Must contain from 8 to 41 characters. <b>Oracle</b> Constraints: Must contain from 8 to 30 characters. <b>PostgreSQL</b> Constraints: Must contain from 8 to 128 characters. Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked. </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="False" position="Named"> <name>MonitoringInterval</name> <description> <para>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0. Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringRoleArn</name> <description> <para>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To create an IAM role for Amazon RDS Enhanced Monitoring</a>. If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value. </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="False" position="Named"> <name>MultiAZ</name> <description> <para> Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. Constraints: Cannot be specified if the DB instance is a Read Replica. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NewDBInstanceIdentifier</name> <description> <para> The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set <code>Apply Immediately</code> to true, or will occur during the next maintenance window if <code>Apply Immediately</code> to false. This value is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - The first character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>mydbinstance</code> </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>OptionGroupName</name> <description> <para> Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </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="False" position="Named"> <name>PerformanceInsightsKMSKeyId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para> The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code> parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. <b>Amazon Aurora</b> Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. Constraints: - Must be in the format hh24:mi-hh24:mi - Times should be in Universal Time Coordinated (UTC) - Must not conflict with the preferred maintenance window - Must be at least 30 minutes </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="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes </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="False" position="Named"> <name>PromotionTier</name> <description> <para>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance"> Fault Tolerance for an Aurora DB Cluster</a>. Default: 1 Valid Values: 0 - 15 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to <code>True</code> to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to <code>False</code> to make the DB instance internal with a DNS name that resolves to a private IP address. <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a public subnet and <code>PubliclyAccessible</code> must be true in order for it to be publicly accessible. Changes to the <code>PubliclyAccessible</code> parameter are applied immediately regardless of the value of the <code>ApplyImmediately</code> parameter. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the DB instance. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </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="False" position="Named"> <name>TdeCredentialArn</name> <description> <para>The ARN from the Key Store with which to associate the instance for TDE encryption. </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="False" position="Named"> <name>TdeCredentialPassword</name> <description> <para>The password for the given ARN from the Key Store in order to access the device. </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="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. <b>Amazon Aurora</b> Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>. Constraints: - If supplied, must match existing VpcSecurityGroupIds. </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.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.ModifyDBInstanceResponse) 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=Edit-RDSDBInstance.html&tocid=Edit-RDSDBInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSDBParameterGroup</name> <description> <para>Invokes the ModifyDBParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSDBParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. <important><para> After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified. </para></important> </para> </description> <syntax> <syntaxItem> <name>Edit-RDSDBParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group. Constraints: - If supplied, must match the name of an existing DBParameterGroup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Parameter</name> <description> <para>An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): <code>immediate | pending-reboot</code> You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Parameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group. Constraints: - If supplied, must match the name of an existing DBParameterGroup. </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="False" 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="False" position="2"> <name>Parameter</name> <description> <para>An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): <code>immediate | pending-reboot</code> You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Parameter[]</parameterValue> <type> <name>Amazon.RDS.Model.Parameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.RDS.Model.ModifyDBParameterGroupResponse) 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=Edit-RDSDBParameterGroup.html&tocid=Edit-RDSDBParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSDBSnapshot</name> <description> <para>Invokes the ModifyDBSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSDBSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. Amazon RDS supports upgrading DB snapshots for MySQL and Oracle. </para> </description> <syntax> <syntaxItem> <name>Edit-RDSDBSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier of the DB snapshot to modify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineVersion</name> <description> <para>The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. <b>MySQL</b> - <code>5.5.46</code> (supported for 5.1 DB snapshots) <b>Oracle</b> - <code>12.1.0.2.v8</code> (supported for 12.1.0.1 DB snapshots) - <code>11.2.0.4.v12</code> (supported for 11.2.0.2 DB snapshots) - <code>11.2.0.4.v11</code> (supported for 11.2.0.3 DB snapshots) </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>The option group to identify with the upgraded DB snapshot. You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG">Option Group Considerations</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier of the DB snapshot to modify. </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>EngineVersion</name> <description> <para>The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. <b>MySQL</b> - <code>5.5.46</code> (supported for 5.1 DB snapshots) <b>Oracle</b> - <code>12.1.0.2.v8</code> (supported for 12.1.0.1 DB snapshots) - <code>11.2.0.4.v12</code> (supported for 11.2.0.2 DB snapshots) - <code>11.2.0.4.v11</code> (supported for 11.2.0.3 DB snapshots) </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="False" 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>OptionGroupName</name> <description> <para>The option group to identify with the upgraded DB snapshot. You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG">Option Group Considerations</a>. </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.RDS.Model.DBSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSnapshot object. The service call response (type Amazon.RDS.Model.ModifyDBSnapshotResponse) 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=Edit-RDSDBSnapshot.html&tocid=Edit-RDSDBSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSDBSnapshotAttribute</name> <description> <para>Invokes the ModifyDBSnapshotAttribute operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSDBSnapshotAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other AWS accounts, specify <code>restore</code> as the <code>AttributeName</code> and use the <code>ValuesToAdd</code> parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value <code>all</code> to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the <code>all</code> value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the <code>ValuesToAdd</code> parameter. You can't use <code>all</code> as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API action. </para> </description> <syntax> <syntaxItem> <name>Edit-RDSDBSnapshotAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot to modify the attributes for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeName</name> <description> <para>The name of the DB snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to <code>restore</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ValuesToAdd</name> <description> <para>A list of DB snapshot attributes to add to the attribute specified by <code>AttributeName</code>. To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or <code>all</code> to make the manual DB snapshot restorable by any AWS account. Do not add the <code>all</code> value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ValuesToRemove</name> <description> <para>A list of DB snapshot attributes to remove from the attribute specified by <code>AttributeName</code>. To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or <code>all</code> to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify <code>all</code>, an AWS account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore the manual DB snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeName</name> <description> <para>The name of the DB snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to <code>restore</code>. </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 (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot to modify the attributes for. </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="False" 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="False" position="Named"> <name>ValuesToAdd</name> <description> <para>A list of DB snapshot attributes to add to the attribute specified by <code>AttributeName</code>. To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or <code>all</code> to make the manual DB snapshot restorable by any AWS account. Do not add the <code>all</code> value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. </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="False" position="Named"> <name>ValuesToRemove</name> <description> <para>A list of DB snapshot attributes to remove from the attribute specified by <code>AttributeName</code>. To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or <code>all</code> to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify <code>all</code>, an AWS account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore the manual DB snapshot. </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.RDS.Model.DBSnapshotAttributesResult</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSnapshotAttributesResult object. The service call response (type Amazon.RDS.Model.ModifyDBSnapshotAttributeResponse) 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=Edit-RDSDBSnapshotAttribute.html&tocid=Edit-RDSDBSnapshotAttribute</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSDBSubnetGroup</name> <description> <para>Invokes the ModifyDBSubnetGroup operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSDBSubnetGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. </para> </description> <syntax> <syntaxItem> <name>Edit-RDSDBSubnetGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSubnetGroupName</name> <description> <para>The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DBSubnetGroupDescription</name> <description> <para>The description for the DB subnet group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SubnetId</name> <description> <para>The EC2 subnet IDs for the DB subnet group. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DBSubnetGroupDescription</name> <description> <para>The description for the DB subnet group. </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 (ByValue, ByPropertyName)" position="1"> <name>DBSubnetGroupName</name> <description> <para>The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: <code>mySubnetgroup</code> </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="False" 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="False" position="3"> <name>SubnetId</name> <description> <para>The EC2 subnet IDs for the DB subnet group. </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.RDS.Model.DBSubnetGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSubnetGroup object. The service call response (type Amazon.RDS.Model.ModifyDBSubnetGroupResponse) 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=Edit-RDSDBSubnetGroup.html&tocid=Edit-RDSDBSubnetGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSEventSubscription</name> <description> <para>Invokes the ModifyEventSubscription operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSEventSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the <a>AddSourceIdentifierToSubscription</a> and <a>RemoveSourceIdentifierFromSubscription</a> calls. You can see a list of the event categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </para> </description> <syntax> <syntaxItem> <name>Edit-RDSEventSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para> A Boolean value; set to <b>true</b> to activate the subscription. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para> A Boolean value; set to <b>true</b> to activate the subscription. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </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="False" 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="2"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </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="False" position="Named"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot </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 (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription. </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.RDS.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventSubscription object. The service call response (type Amazon.RDS.Model.ModifyEventSubscriptionResponse) 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=Edit-RDSEventSubscription.html&tocid=Edit-RDSEventSubscription</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Edit-RDSOptionGroup</name> <description> <para>Invokes the ModifyOptionGroup operation against Amazon Relational Database Service.</para> </description> <verb>Edit</verb> <noun>RDSOptionGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies an existing option group. </para> </description> <syntax> <syntaxItem> <name>Edit-RDSOptionGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>OptionGroupName</name> <description> <para>The name of the option group to be modified. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ApplyImmediately</name> <description> <para>Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OptionsToInclude</name> <description> <para>Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.OptionConfiguration[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OptionsToRemove</name> <description> <para>Options in this list are removed from the option group. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>ApplyImmediately</name> <description> <para>Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>OptionGroupName</name> <description> <para>The name of the option group to be modified. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </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="False" position="Named"> <name>OptionsToInclude</name> <description> <para>Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.OptionConfiguration[]</parameterValue> <type> <name>Amazon.RDS.Model.OptionConfiguration[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OptionsToRemove</name> <description> <para>Options in this list are removed from the option group. </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.RDS.Model.OptionGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a OptionGroup object. The service call response (type Amazon.RDS.Model.ModifyOptionGroupResponse) 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=Edit-RDSOptionGroup.html&tocid=Edit-RDSOptionGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Enable-RDSDBSecurityGroupIngress</name> <description> <para>Invokes the AuthorizeDBSecurityGroupIngress operation against Amazon Relational Database Service.</para> </description> <verb>Enable</verb> <noun>RDSDBSecurityGroupIngress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You cannot authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </description> <syntax> <syntaxItem> <name>Enable-RDSDBSecurityGroupIngress</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name of the DB security group to add authorization to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>CIDRIP</name> <description> <para>The IP range to authorize. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EC2SecurityGroupId</name> <description> <para> Id of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EC2SecurityGroupName</name> <description> <para> Name of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EC2SecurityGroupOwnerId</name> <description> <para> AWS account number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>CIDRIP</name> <description> <para>The IP range to authorize. </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 (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name of the DB security group to add authorization to. </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>EC2SecurityGroupId</name> <description> <para> Id of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </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>EC2SecurityGroupName</name> <description> <para> Name of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </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>EC2SecurityGroupOwnerId</name> <description> <para> AWS account number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBSecurityGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSecurityGroup object. The service call response (type Amazon.RDS.Model.AuthorizeDBSecurityGroupIngressResponse) 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=Enable-RDSDBSecurityGroupIngress.html&tocid=Enable-RDSDBSecurityGroupIngress</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSAccountAttribute</name> <description> <para>Invokes the DescribeAccountAttributes operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSAccountAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command does not take any parameters. </para> </description> <syntax> <syntaxItem> <name>Get-RDSAccountAttribute</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.AccountQuota</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of AccountQuota objects. The service call response (type Amazon.RDS.Model.DescribeAccountAttributesResponse) 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-RDSAccountAttribute.html&tocid=Get-RDSAccountAttribute</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSCertificate</name> <description> <para>Invokes the DescribeCertificates operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSCertificate</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the set of CA certificates provided by Amazon RDS for this AWS account.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSCertificate</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CertificateIdentifier</name> <description> <para>The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive. Constraints: - Must match an existing CertificateIdentifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <a>DescribeCertificates</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CertificateIdentifier</name> <description> <para>The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive. Constraints: - Must match an existing CertificateIdentifier. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <a>DescribeCertificates</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.Certificate</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Certificate objects. The service call response (type Amazon.RDS.Model.DescribeCertificatesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSCertificate.html&tocid=Get-RDSCertificate</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBCluster</name> <description> <para>Invokes the DescribeDBClusters operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: - If supplied, must match an existing DBClusterIdentifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>A filter that specifies one or more DB clusters to describe. Supported filters: - <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <a>DescribeDBClusters</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: - If supplied, must match an existing DBClusterIdentifier. </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="False" position="Named"> <name>Filter</name> <description> <para>A filter that specifies one or more DB clusters to describe. Supported filters: - <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <a>DescribeDBClusters</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBCluster objects. The service call response (type Amazon.RDS.Model.DescribeDBClustersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBCluster.html&tocid=Get-RDSDBCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBClusterParameter</name> <description> <para>Invokes the DescribeDBClusterParameters operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBClusterParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBClusterParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of a specific DB cluster parameter group to return parameter details for. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Source</name> <description> <para> A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of a specific DB cluster parameter group to return parameter details for. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Source</name> <description> <para> A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>. </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.RDS.Model.Parameter</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Parameter objects. The service call response (type Amazon.RDS.Model.DescribeDBClusterParametersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBClusterParameter.html&tocid=Get-RDSDBClusterParameter</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBClusterParameterGroup</name> <description> <para>Invokes the DescribeDBClusterParameterGroups operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of a specific DB cluster parameter group to return details for. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBClusterParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of a specific DB cluster parameter group to return details for. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBClusterParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBClusterParameterGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBClusterParameterGroup objects. The service call response (type Amazon.RDS.Model.DescribeDBClusterParameterGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBClusterParameterGroup.html&tocid=Get-RDSDBClusterParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBClusterSnapshot</name> <description> <para>Invokes the DescribeDBClusterSnapshots operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case-sensitive. Constraints: - If supplied, must match the identifier of an existing DBCluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterSnapshotIdentifier</name> <description> <para>A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. Constraints: - If supplied, must match the identifier of an existing DBClusterSnapshot. - If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludePublic</name> <description> <para>Set this value to <code>true</code> to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to <code>false</code>. The default is <code>false</code>. The default is false. You can share a manual DB cluster snapshot as public by using the <a>ModifyDBClusterSnapshotAttribute</a> API action. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeShared</name> <description> <para>Set this value to <code>true</code> to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to <code>false</code>. The default is <code>false</code>. You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the <a>ModifyDBClusterSnapshotAttribute</a> API action. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotType</name> <description> <para>The type of DB cluster snapshots to be returned. You can specify one of the following values: - <code>automated</code> - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account. - <code>manual</code> - Return all DB cluster snapshots that have been taken by my AWS account. - <code>shared</code> - Return all manual DB cluster snapshots that have been shared to my AWS account. - <code>public</code> - Return all DB cluster snapshots that have been marked as public. If you don't specify a <code>SnapshotType</code> value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public DB cluster snapshots with these results by setting the <code>IncludePublic</code> parameter to <code>true</code>. The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case-sensitive. Constraints: - If supplied, must match the identifier of an existing DBCluster. </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="False" position="Named"> <name>DBClusterSnapshotIdentifier</name> <description> <para>A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. Constraints: - If supplied, must match the identifier of an existing DBClusterSnapshot. - If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludePublic</name> <description> <para>Set this value to <code>true</code> to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to <code>false</code>. The default is <code>false</code>. The default is false. You can share a manual DB cluster snapshot as public by using the <a>ModifyDBClusterSnapshotAttribute</a> API action. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeShared</name> <description> <para>Set this value to <code>true</code> to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to <code>false</code>. The default is <code>false</code>. You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the <a>ModifyDBClusterSnapshotAttribute</a> API action. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotType</name> <description> <para>The type of DB cluster snapshots to be returned. You can specify one of the following values: - <code>automated</code> - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account. - <code>manual</code> - Return all DB cluster snapshots that have been taken by my AWS account. - <code>shared</code> - Return all manual DB cluster snapshots that have been shared to my AWS account. - <code>public</code> - Return all DB cluster snapshots that have been marked as public. If you don't specify a <code>SnapshotType</code> value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public DB cluster snapshots with these results by setting the <code>IncludePublic</code> parameter to <code>true</code>. The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>. </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.RDS.Model.DBClusterSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBClusterSnapshot objects. The service call response (type Amazon.RDS.Model.DescribeDBClusterSnapshotsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBClusterSnapshot.html&tocid=Get-RDSDBClusterSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBClusterSnapshotAttribute</name> <description> <para>Invokes the DescribeDBClusterSnapshotAttributes operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBClusterSnapshotAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, <code>DescribeDBClusterSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the <a>ModifyDBClusterSnapshotAttribute</a> API action. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBClusterSnapshotAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterSnapshotIdentifier</name> <description> <para>The identifier for the DB cluster snapshot to describe the attributes for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterSnapshotIdentifier</name> <description> <para>The identifier for the DB cluster snapshot to describe the attributes for. </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.RDS.Model.DBClusterSnapshotAttributesResult</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBClusterSnapshotAttributesResult object. The service call response (type Amazon.RDS.Model.DescribeDBClusterSnapshotAttributesResponse) 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-RDSDBClusterSnapshotAttribute.html&tocid=Get-RDSDBClusterSnapshotAttribute</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBEngineVersion</name> <description> <para>Invokes the DescribeDBEngineVersions operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBEngineVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of the available DB engines.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBEngineVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Engine</name> <description> <para>The database engine to return. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>EngineVersion</name> <description> <para>The database engine version to return. Example: <code>5.1.49</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DBParameterGroupFamily</name> <description> <para>The name of a specific DB parameter group family to return details for. Constraints: - If supplied, must match an existing DBParameterGroupFamily. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultOnly</name> <description> <para>Indicates that only the default version of the specified engine or engine and major version combination is returned. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListSupportedCharacterSet</name> <description> <para>If this parameter is specified and the requested engine supports the <code>CharacterSetName</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine version. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListSupportedTimezone</name> <description> <para>If this parameter is specified and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported time zones for each engine version. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DBParameterGroupFamily</name> <description> <para>The name of a specific DB parameter group family to return details for. Constraints: - If supplied, must match an existing DBParameterGroupFamily. </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="False" position="Named"> <name>DefaultOnly</name> <description> <para>Indicates that only the default version of the specified engine or engine and major version combination is returned. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Engine</name> <description> <para>The database engine to return. </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="2"> <name>EngineVersion</name> <description> <para>The database engine version to return. Example: <code>5.1.49</code> </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="False" position="Named"> <name>Filter</name> <description> <para>Not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListSupportedCharacterSet</name> <description> <para>If this parameter is specified and the requested engine supports the <code>CharacterSetName</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine version. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ListSupportedTimezone</name> <description> <para>If this parameter is specified and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported time zones for each engine version. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBEngineVersion</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBEngineVersion objects. The service call response (type Amazon.RDS.Model.DescribeDBEngineVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBEngineVersion.html&tocid=Get-RDSDBEngineVersion</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBInstance</name> <description> <para>Invokes the DescribeDBInstances operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about provisioned RDS instances. This API supports pagination.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: - If supplied, must match the identifier of an existing DBInstance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>A filter that specifies one or more DB instances to describe. Supported filters: - <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB Clusters identified by these ARNs. - <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: - If supplied, must match the identifier of an existing DBInstance. </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="False" position="Named"> <name>Filter</name> <description> <para>A filter that specifies one or more DB instances to describe. Supported filters: - <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB Clusters identified by these ARNs. - <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBInstance objects. The service call response (type Amazon.RDS.Model.DescribeDBInstancesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBInstance.html&tocid=Get-RDSDBInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBLogFile</name> <description> <para>Invokes the DescribeDBLogFiles operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBLogFile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of DB log files for the DB instance.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBLogFile</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: - Must match the identifier of an existing DBInstance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FileLastWritten</name> <description> <para>Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FilenameContains</name> <description> <para>Filters the available log files for log file names that contain the specified string. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FileSize</name> <description> <para>Filters the available log files for files larger than the specified size. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: - Must match the identifier of an existing DBInstance. </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="False" position="Named"> <name>FileLastWritten</name> <description> <para>Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FilenameContains</name> <description> <para>Filters the available log files for log file names that contain the specified string. </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="False" position="Named"> <name>FileSize</name> <description> <para>Filters the available log files for files larger than the specified size. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DescribeDBLogFilesDetails</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DescribeDBLogFilesDetails objects. The service call response (type Amazon.RDS.Model.DescribeDBLogFilesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBLogFile.html&tocid=Get-RDSDBLogFile</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBLogFilePortion</name> <description> <para>Invokes the DownloadDBLogFilePortion operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBLogFilePortion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Downloads all or a portion of the specified log file, up to 1 MB in size. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBLogFilePortion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: - Must match the identifier of an existing DBInstance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>LogFileName</name> <description> <para>The name of the log file to be downloaded. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NumberOfLines</name> <description> <para>The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size. If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter. - If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first. - If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned. - If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned. - You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: - Must match the identifier of an existing DBInstance. </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="False" position="2"> <name>LogFileName</name> <description> <para>The name of the log file to be downloaded. </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="False" position="Named"> <name>Marker</name> <description> <para>The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>NumberOfLines</name> <description> <para>The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size. If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter. - If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first. - If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned. - If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned. - You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DownloadDBLogFilePortionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.RDS.Model.DownloadDBLogFilePortionResponse 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-RDSDBLogFilePortion.html&tocid=Get-RDSDBLogFilePortion</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBParameter</name> <description> <para>Invokes the DescribeDBParameters operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the detailed parameter list for a particular DB parameter group.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of a specific DB parameter group to return details for. Constraints: - If supplied, must match the name of an existing DBParameterGroup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Source</name> <description> <para>The parameter types to return. Default: All parameter types returned Valid Values: <code>user | system | engine-default</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of a specific DB parameter group to return details for. Constraints: - If supplied, must match the name of an existing DBParameterGroup. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Source</name> <description> <para>The parameter types to return. Default: All parameter types returned Valid Values: <code>user | system | engine-default</code> </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.RDS.Model.Parameter</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Parameter objects. The service call response (type Amazon.RDS.Model.DescribeDBParametersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBParameter.html&tocid=Get-RDSDBParameter</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBParameterGroup</name> <description> <para>Invokes the DescribeDBParameterGroups operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of a specific DB parameter group to return details for. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of a specific DB parameter group to return details for. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBParameterGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBParameterGroup objects. The service call response (type Amazon.RDS.Model.DescribeDBParameterGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBParameterGroup.html&tocid=Get-RDSDBParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBSecurityGroup</name> <description> <para>Invokes the DescribeDBSecurityGroups operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBSecurityGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBSecurityGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name of the DB security group to return details for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBSecurityGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name of the DB security group to return details for. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBSecurityGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBSecurityGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBSecurityGroup objects. The service call response (type Amazon.RDS.Model.DescribeDBSecurityGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBSecurityGroup.html&tocid=Get-RDSDBSecurityGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBSnapshot</name> <description> <para>Invokes the DescribeDBSnapshots operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about DB snapshots. This API action supports pagination.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with <code>DBSnapshotIdentifier</code>. This parameter is not case-sensitive. Constraints: - If supplied, must match the identifier of an existing DBInstance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DBSnapshotIdentifier</name> <description> <para> A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with <code>DBInstanceIdentifier</code>. This value is stored as a lowercase string. Constraints: - If supplied, must match the identifier of an existing DBSnapshot. - If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SnapshotType</name> <description> <para>The type of snapshots to be returned. You can specify one of the following values: - <code>automated</code> - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account. - <code>manual</code> - Return all DB snapshots that have been taken by my AWS account. - <code>shared</code> - Return all manual DB snapshots that have been shared to my AWS account. - <code>public</code> - Return all DB snapshots that have been marked as public. If you don't specify a <code>SnapshotType</code> value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public snapshots with these results by setting the <code>IncludePublic</code> parameter to <code>true</code>. The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludePublic</name> <description> <para>Set this value to <code>true</code> to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to <code>false</code>. The default is <code>false</code>. You can share a manual DB snapshot as public by using the <a>ModifyDBSnapshotAttribute</a> API. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeShared</name> <description> <para>Set this value to <code>true</code> to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to <code>false</code>. The default is <code>false</code>. You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the <a>ModifyDBSnapshotAttribute</a> API action. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with <code>DBSnapshotIdentifier</code>. This parameter is not case-sensitive. Constraints: - If supplied, must match the identifier of an existing DBInstance. </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="2"> <name>DBSnapshotIdentifier</name> <description> <para> A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with <code>DBInstanceIdentifier</code>. This value is stored as a lowercase string. Constraints: - If supplied, must match the identifier of an existing DBSnapshot. - If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludePublic</name> <description> <para>Set this value to <code>true</code> to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to <code>false</code>. The default is <code>false</code>. You can share a manual DB snapshot as public by using the <a>ModifyDBSnapshotAttribute</a> API. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IncludeShared</name> <description> <para>Set this value to <code>true</code> to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to <code>false</code>. The default is <code>false</code>. You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the <a>ModifyDBSnapshotAttribute</a> API action. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeDBSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SnapshotType</name> <description> <para>The type of snapshots to be returned. You can specify one of the following values: - <code>automated</code> - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account. - <code>manual</code> - Return all DB snapshots that have been taken by my AWS account. - <code>shared</code> - Return all manual DB snapshots that have been shared to my AWS account. - <code>public</code> - Return all DB snapshots that have been marked as public. If you don't specify a <code>SnapshotType</code> value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public snapshots with these results by setting the <code>IncludePublic</code> parameter to <code>true</code>. The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>. </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.RDS.Model.DBSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBSnapshot objects. The service call response (type Amazon.RDS.Model.DescribeDBSnapshotsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBSnapshot.html&tocid=Get-RDSDBSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBSnapshotAttribute</name> <description> <para>Invokes the DescribeDBSnapshotAttributes operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBSnapshotAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other AWS accounts, <code>DescribeDBSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the <a>ModifyDBSnapshotAttribute</a> API action. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBSnapshotAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot to describe the attributes for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot to describe the attributes for. </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.RDS.Model.DBSnapshotAttributesResult</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSnapshotAttributesResult object. The service call response (type Amazon.RDS.Model.DescribeDBSnapshotAttributesResponse) 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-RDSDBSnapshotAttribute.html&tocid=Get-RDSDBSnapshotAttribute</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSDBSubnetGroup</name> <description> <para>Invokes the DescribeDBSubnetGroups operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSDBSubnetGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSDBSubnetGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSubnetGroupName</name> <description> <para>The name of the DB subnet group to return details for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSubnetGroupName</name> <description> <para>The name of the DB subnet group to return details for. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBSubnetGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DBSubnetGroup objects. The service call response (type Amazon.RDS.Model.DescribeDBSubnetGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSDBSubnetGroup.html&tocid=Get-RDSDBSubnetGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSEngineDefaultClusterParameter</name> <description> <para>Invokes the DescribeEngineDefaultClusterParameters operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSEngineDefaultClusterParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Get-RDSEngineDefaultClusterParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBParameterGroupFamily</name> <description> <para>The name of the DB cluster parameter group family to return engine parameter information for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeEngineDefaultClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBParameterGroupFamily</name> <description> <para>The name of the DB cluster parameter group family to return engine parameter information for. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeEngineDefaultClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.EngineDefaults</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EngineDefaults object. The service call response (type Amazon.RDS.Model.DescribeEngineDefaultClusterParametersResponse) 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-RDSEngineDefaultClusterParameter.html&tocid=Get-RDSEngineDefaultClusterParameter</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSEngineDefaultParameter</name> <description> <para>Invokes the DescribeEngineDefaultParameters operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSEngineDefaultParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the default engine and system parameter information for the specified database engine. </para> </description> <syntax> <syntaxItem> <name>Get-RDSEngineDefaultParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBParameterGroupFamily</name> <description> <para>The name of the DB parameter group family. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeEngineDefaultParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBParameterGroupFamily</name> <description> <para>The name of the DB parameter group family. </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="False" position="Named"> <name>Filter</name> <description> <para>Not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribeEngineDefaultParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.EngineDefaults</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EngineDefaults object. The service call response (type Amazon.RDS.Model.DescribeEngineDefaultParametersResponse) 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-RDSEngineDefaultParameter.html&tocid=Get-RDSEngineDefaultParameter</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSEvent</name> <description> <para>Invokes the DescribeEvents operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSEvent</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSEvent</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SourceIdentifier</name> <description> <para>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response. Constraints: - If SourceIdentifier is supplied, SourceType must also be provided. - If the source type is <code>DBInstance</code>, then a <code>DBInstanceIdentifier</code> must be supplied. - If the source type is <code>DBSecurityGroup</code>, a <code>DBSecurityGroupName</code> must be supplied. - If the source type is <code>DBParameterGroup</code>, a <code>DBParameterGroupName</code> must be supplied. - If the source type is <code>DBSnapshot</code>, a <code>DBSnapshotIdentifier</code> must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SourceType</name> <description> <para>The event source to retrieve events for. If no value is specified, all events are returned. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The number of minutes to retrieve events for. Default: 60 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para> The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: 2009-07-08T18:00Z </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para>A list of event categories that trigger notifications for a event notification subscription. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: 2009-07-08T18:00Z </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The number of minutes to retrieve events for. Default: 60 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndTime</name> <description> <para> The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: 2009-07-08T18:00Z </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para>A list of event categories that trigger notifications for a event notification subscription. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SourceIdentifier</name> <description> <para>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response. Constraints: - If SourceIdentifier is supplied, SourceType must also be provided. - If the source type is <code>DBInstance</code>, then a <code>DBInstanceIdentifier</code> must be supplied. - If the source type is <code>DBSecurityGroup</code>, a <code>DBSecurityGroupName</code> must be supplied. - If the source type is <code>DBParameterGroup</code>, a <code>DBParameterGroupName</code> must be supplied. - If the source type is <code>DBSnapshot</code>, a <code>DBSnapshotIdentifier</code> must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens. </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="False" position="2"> <name>SourceType</name> <description> <para>The event source to retrieve events for. If no value is specified, all events are returned. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.SourceType</parameterValue> <type> <name>Amazon.RDS.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StartTime</name> <description> <para> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a> Example: 2009-07-08T18:00Z </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.Event</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Event objects. The service call response (type Amazon.RDS.Model.DescribeEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSEvent.html&tocid=Get-RDSEvent</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSEventCategory</name> <description> <para>Invokes the DescribeEventCategories operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSEventCategory</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html"> Events</a> topic in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Get-RDSEventCategory</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot </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.RDS.Model.EventCategoriesMap</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of EventCategoriesMap objects. The service call response (type Amazon.RDS.Model.DescribeEventCategoriesResponse) 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-RDSEventCategory.html&tocid=Get-RDSEventCategory</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSEventSubscription</name> <description> <para>Invokes the DescribeEventSubscriptions operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSEventSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSEventSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription you want to describe. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription you want to describe. </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.RDS.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of EventSubscription objects. The service call response (type Amazon.RDS.Model.DescribeEventSubscriptionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSEventSubscription.html&tocid=Get-RDSEventSubscription</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSOptionGroup</name> <description> <para>Invokes the DescribeOptionGroups operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSOptionGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the available option groups.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSOptionGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>OptionGroupName</name> <description> <para>The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineName</name> <description> <para>Filters the list of option groups to only include groups associated with a specific database engine. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MajorEngineVersion</name> <description> <para>Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineName</name> <description> <para>Filters the list of option groups to only include groups associated with a specific database engine. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MajorEngineVersion</name> <description> <para>Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified. </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="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>OptionGroupName</name> <description> <para>The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion. </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.RDS.Model.OptionGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of OptionGroup objects. The service call response (type Amazon.RDS.Model.DescribeOptionGroupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSOptionGroup.html&tocid=Get-RDSOptionGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSOptionGroupOption</name> <description> <para>Invokes the DescribeOptionGroupOptions operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSOptionGroupOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes all available options.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSOptionGroupOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EngineName</name> <description> <para>A required parameter. Options available for the given engine name will be described. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>MajorEngineVersion</name> <description> <para>If specified, filters the results to include only options for the specified major engine version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>EngineName</name> <description> <para>A required parameter. Options available for the given engine name will be described. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>MajorEngineVersion</name> <description> <para>If specified, filters the results to include only options for the specified major engine version. </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="False" position="Named"> <name>Marker</name> <description> <para>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.OptionGroupOption</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of OptionGroupOption objects. The service call response (type Amazon.RDS.Model.DescribeOptionGroupOptionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSOptionGroupOption.html&tocid=Get-RDSOptionGroupOption</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSOrderableDBInstanceOption</name> <description> <para>Invokes the DescribeOrderableDBInstanceOptions operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSOrderableDBInstanceOption</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of orderable DB instance options for the specified engine.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSOrderableDBInstanceOption</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Engine</name> <description> <para>The name of the engine to retrieve DB instance options for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineVersion</name> <description> <para>The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Vpc</name> <description> <para>The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. </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 (ByValue, ByPropertyName)" position="1"> <name>Engine</name> <description> <para>The name of the engine to retrieve DB instance options for. </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>EngineVersion</name> <description> <para>The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. </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="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Vpc</name> <description> <para>The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.OrderableDBInstanceOption</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of OrderableDBInstanceOption objects. The service call response (type Amazon.RDS.Model.DescribeOrderableDBInstanceOptionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSOrderableDBInstanceOption.html&tocid=Get-RDSOrderableDBInstanceOption</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSPendingMaintenanceAction</name> <description> <para>Invokes the DescribePendingMaintenanceActions operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSPendingMaintenanceAction</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSPendingMaintenanceAction</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceIdentifier</name> <description> <para>The ARN of a resource to return pending maintenance actions for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: - <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs. - <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: - <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs. - <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceIdentifier</name> <description> <para>The ARN of a resource to return pending maintenance actions for. </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.RDS.Model.ResourcePendingMaintenanceActions</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ResourcePendingMaintenanceActions objects. The service call response (type Amazon.RDS.Model.DescribePendingMaintenanceActionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSPendingMaintenanceAction.html&tocid=Get-RDSPendingMaintenanceAction</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSReservedDBInstance</name> <description> <para>Invokes the DescribeReservedDBInstances operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSReservedDBInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about reserved DB instances for this account, or about a specified reserved DB instance.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSReservedDBInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedDBInstanceId</name> <description> <para>The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: <code>1 | 3 | 31536000 | 94608000</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MultiAZ</name> <description> <para>The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OfferingType</name> <description> <para>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: <code>"Partial Upfront" | "All Upfront" | "No Upfront" </code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductDescription</name> <description> <para>The product description filter value. Specify this parameter to show only those reservations matching the specified product description. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ReservedDBInstancesOfferingId</name> <description> <para>The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class. </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="False" position="Named"> <name>Duration</name> <description> <para>The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: <code>1 | 3 | 31536000 | 94608000</code> </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MultiAZ</name> <description> <para>The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OfferingType</name> <description> <para>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: <code>"Partial Upfront" | "All Upfront" | "No Upfront" </code> </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="False" position="Named"> <name>ProductDescription</name> <description> <para>The product description filter value. Specify this parameter to show only those reservations matching the specified product description. </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 (ByValue, ByPropertyName)" position="1"> <name>ReservedDBInstanceId</name> <description> <para>The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. </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>ReservedDBInstancesOfferingId</name> <description> <para>The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. </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.RDS.Model.ReservedDBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ReservedDBInstance objects. The service call response (type Amazon.RDS.Model.DescribeReservedDBInstancesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSReservedDBInstance.html&tocid=Get-RDSReservedDBInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSReservedDBInstancesOffering</name> <description> <para>Invokes the PurchaseReservedDBInstancesOffering operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSReservedDBInstancesOffering</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Purchases a reserved DB instance offering. </para> </description> <syntax> <syntaxItem> <name>Get-RDSReservedDBInstancesOffering</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedDBInstancesOfferingId</name> <description> <para>The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBInstanceCount</name> <description> <para>The number of instances to reserve. Default: <code>1</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ReservedDBInstanceId</name> <description> <para>Customer-specified identifier to track this reservation. Example: myreservationID </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBInstanceCount</name> <description> <para>The number of instances to reserve. Default: <code>1</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ReservedDBInstanceId</name> <description> <para>Customer-specified identifier to track this reservation. Example: myreservationID </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 (ByValue, ByPropertyName)" position="1"> <name>ReservedDBInstancesOfferingId</name> <description> <para>The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.ReservedDBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ReservedDBInstance object. The service call response (type Amazon.RDS.Model.PurchaseReservedDBInstancesOfferingResponse) 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-RDSReservedDBInstancesOffering.html&tocid=Get-RDSReservedDBInstancesOffering</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSReservedDBInstancesOfferingList</name> <description> <para>Invokes the DescribeReservedDBInstancesOfferings operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSReservedDBInstancesOfferingList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists available reserved DB instance offerings.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSReservedDBInstancesOfferingList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ReservedDBInstancesOfferingId</name> <description> <para>The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. Example: <code>438012d3-4052-4cc7-b2e3-8d3372e0e706</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Duration</name> <description> <para>Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: <code>1 | 3 | 31536000 | 94608000</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MultiAZ</name> <description> <para>The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OfferingType</name> <description> <para>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: <code>"Partial Upfront" | "All Upfront" | "No Upfront" </code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ProductDescription</name> <description> <para>Product description filter value. Specify this parameter to show only the available offerings matching the specified product description. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. </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="False" position="Named"> <name>Duration</name> <description> <para>Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: <code>1 | 3 | 31536000 | 94608000</code> </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="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MultiAZ</name> <description> <para>The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OfferingType</name> <description> <para>The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: <code>"Partial Upfront" | "All Upfront" | "No Upfront" </code> </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="False" position="Named"> <name>ProductDescription</name> <description> <para>Product description filter value. Specify this parameter to show only the available offerings matching the specified product description. </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 (ByValue, ByPropertyName)" position="1"> <name>ReservedDBInstancesOfferingId</name> <description> <para>The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. Example: <code>438012d3-4052-4cc7-b2e3-8d3372e0e706</code> </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.RDS.Model.ReservedDBInstancesOffering</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ReservedDBInstancesOffering objects. The service call response (type Amazon.RDS.Model.DescribeReservedDBInstancesOfferingsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSReservedDBInstancesOfferingList.html&tocid=Get-RDSReservedDBInstancesOfferingList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSSourceRegion</name> <description> <para>Invokes the DescribeSourceRegions operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSSourceRegion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of the source AWS regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-RDSSourceRegion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegionName</name> <description> <para>The source AWS Region name. For example, <code>us-east-1</code>. Constraints: - Must specify a valid AWS Region name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <a>DescribeSourceRegions</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Marker</name> <description> <para> An optional pagination token provided by a previous <a>DescribeSourceRegions</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>MaxRecord</name> <description> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RegionName</name> <description> <para>The source AWS Region name. For example, <code>us-east-1</code>. Constraints: - Must specify a valid AWS Region name. </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.RDS.Model.SourceRegion</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of SourceRegion objects. The service call response (type Amazon.RDS.Model.DescribeSourceRegionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Marker (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-RDSSourceRegion.html&tocid=Get-RDSSourceRegion</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSTagForResource</name> <description> <para>Invokes the ListTagsForResource operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSTagForResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </description> <syntax> <syntaxItem> <name>Get-RDSTagForResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceName</name> <description> <para>The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>This parameter is not currently supported. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Filter[]</parameterValue> <type> <name>Amazon.RDS.Model.Filter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceName</name> <description> <para>The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. </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.RDS.Model.Tag</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Tag objects. The service call response (type Amazon.RDS.Model.ListTagsForResourceResponse) 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-RDSTagForResource.html&tocid=Get-RDSTagForResource</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-RDSValidDBInstanceModification</name> <description> <para>Invokes the DescribeValidDBInstanceModifications operation against Amazon Relational Database Service.</para> </description> <verb>Get</verb> <noun>RDSValidDBInstanceModification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>You can call <a>DescribeValidDBInstanceModifications</a> to learn what modifications you can make to your DB instance. You can use this information when you call <a>ModifyDBInstance</a>. </para> </description> <syntax> <syntaxItem> <name>Get-RDSValidDBInstanceModification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The customer identifier or the ARN of your DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The customer identifier or the ARN of your DB instance. </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.RDS.Model.ValidDBInstanceModificationsMessage</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ValidDBInstanceModificationsMessage object. The service call response (type Amazon.RDS.Model.DescribeValidDBInstanceModificationsResponse) 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-RDSValidDBInstanceModification.html&tocid=Get-RDSValidDBInstanceModification</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBCluster</name> <description> <para>Invokes the CreateDBCluster operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new Amazon Aurora DB cluster. You can use the <code>ReplicationSourceIdentifier</code> parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by <code>ReplicationSourceIdentifier</code> is encrypted, you must also specify the <code>PreSignedUrl</code> parameter. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>New-RDSDBCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>my-cluster1</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions and Availability Zones</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: - Must be a value from 1 to 35 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CharacterSetName</name> <description> <para>A value that indicates that the DB cluster should be associated with the specified CharacterSet. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DatabaseName</name> <description> <para>The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterParameterGroupName</name> <description> <para> The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, <code>default.aurora5.6</code> will be used. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The name of the database engine to be used for this DB cluster. Valid Values: <code>aurora</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineVersion</name> <description> <para>The version number of the database engine to use. <b>Aurora</b> Example: <code>5.6.10a</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key is not specified in <code>KmsKeyId</code>: - If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key. - If the <code>StorageEncrypted</code> parameter is true and <code>ReplicationSourceIdentifier</code> is not specified, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set <code>KmsKeyId</code> to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUsername</name> <description> <para>The name of the master user for the DB cluster. Constraints: - Must be 1 to 16 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>A value that indicates that the DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the instances in the DB cluster accept connections. Default: <code>3306</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreSignedUrl</name> <description> <para>A URL that contains a Signature Version 4 signed request for the <code>CreateDBCluster</code> action to be called in the source AWS Region where the DB cluster will be replicated from. You only need to specify <code>PreSignedUrl</code> when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the <code>CreateDBCluster</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the <code>CreateDBCluster</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL. - <code>DestinationRegion</code> - The name of the AWS Region that Aurora Read Replica will be created in. - <code>ReplicationSourceIdentifier</code> - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 region, then your <code>ReplicationSourceIdentifier</code> would look like Example: <code>arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html"> Signature Version 4 Signing Process</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ReplicationSourceIdentifier</name> <description> <para>The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceRegion</name> <description> <para> The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageEncrypted</name> <description> <para>Specifies whether the DB cluster is encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of EC2 VPC security groups to associate with this DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions and Availability Zones</a>. </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="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: - Must be a value from 1 to 35 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CharacterSetName</name> <description> <para>A value that indicates that the DB cluster should be associated with the specified CharacterSet. </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="False" position="Named"> <name>DatabaseName</name> <description> <para>The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating. </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 (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>my-cluster1</code> </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="False" position="Named"> <name>DBClusterParameterGroupName</name> <description> <para> The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, <code>default.aurora5.6</code> will be used. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </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>DBSubnetGroupName</name> <description> <para>A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: <code>mySubnetgroup</code> </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The name of the database engine to be used for this DB cluster. Valid Values: <code>aurora</code> </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>EngineVersion</name> <description> <para>The version number of the database engine to use. <b>Aurora</b> Example: <code>5.6.10a</code> </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="False" 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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key is not specified in <code>KmsKeyId</code>: - If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key. - If the <code>StorageEncrypted</code> parameter is true and <code>ReplicationSourceIdentifier</code> is not specified, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set <code>KmsKeyId</code> to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region. </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="False" position="Named"> <name>MasterUsername</name> <description> <para>The name of the master user for the DB cluster. Constraints: - Must be 1 to 16 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. </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="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. </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>OptionGroupName</name> <description> <para>A value that indicates that the DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster. </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the instances in the DB cluster accept connections. Default: <code>3306</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </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="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. </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="False" position="Named"> <name>PreSignedUrl</name> <description> <para>A URL that contains a Signature Version 4 signed request for the <code>CreateDBCluster</code> action to be called in the source AWS Region where the DB cluster will be replicated from. You only need to specify <code>PreSignedUrl</code> when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the <code>CreateDBCluster</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the <code>CreateDBCluster</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL. - <code>DestinationRegion</code> - The name of the AWS Region that Aurora Read Replica will be created in. - <code>ReplicationSourceIdentifier</code> - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 region, then your <code>ReplicationSourceIdentifier</code> would look like Example: <code>arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html"> Signature Version 4 Signing Process</a>. </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="False" position="Named"> <name>ReplicationSourceIdentifier</name> <description> <para>The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. </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="False" position="Named"> <name>SourceRegion</name> <description> <para> The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. </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="False" position="Named"> <name>StorageEncrypted</name> <description> <para>Specifies whether the DB cluster is encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of EC2 VPC security groups to associate with this DB cluster. </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.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBCluster object. The service call response (type Amazon.RDS.Model.CreateDBClusterResponse) 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=New-RDSDBCluster.html&tocid=New-RDSDBCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBClusterParameterGroup</name> <description> <para>Invokes the CreateDBClusterParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using <a>ModifyDBClusterParameterGroup</a>. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using <a>ModifyDBCluster</a>. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. <important><para> After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified. </para></important> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>New-RDSDBClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group. Constraints: - Must match the name of an existing DBClusterParameterGroup. This value is stored as a lowercase string. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBParameterGroupFamily</name> <description> <para>The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The description for the DB cluster parameter group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group. Constraints: - Must match the name of an existing DBClusterParameterGroup. This value is stored as a lowercase string. </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="False" position="Named"> <name>DBParameterGroupFamily</name> <description> <para>The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. </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="False" position="Named"> <name>Description</name> <description> <para>The description for the DB cluster parameter group. </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="False" 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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBClusterParameterGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBClusterParameterGroup object. The service call response (type Amazon.RDS.Model.CreateDBClusterParameterGroupResponse) 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=New-RDSDBClusterParameterGroup.html&tocid=New-RDSDBClusterParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBClusterSnapshot</name> <description> <para>Invokes the CreateDBClusterSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>New-RDSDBClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. Constraints: - Must match the identifier of an existing DBCluster. Example: <code>my-cluster1</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterSnapshotIdentifier</name> <description> <para>The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>my-cluster1-snapshot1</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>The tags to be assigned to the DB cluster snapshot. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. Constraints: - Must match the identifier of an existing DBCluster. Example: <code>my-cluster1</code> </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="False" position="Named"> <name>DBClusterSnapshotIdentifier</name> <description> <para>The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>my-cluster1-snapshot1</code> </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="False" 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="False" position="Named"> <name>Tag</name> <description> <para>The tags to be assigned to the DB cluster snapshot. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBClusterSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBClusterSnapshot object. The service call response (type Amazon.RDS.Model.CreateDBClusterSnapshotResponse) 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=New-RDSDBClusterSnapshot.html&tocid=New-RDSDBClusterSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBInstance</name> <description> <para>Invokes the CreateDBInstance operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new DB instance. </para> </description> <syntax> <syntaxItem> <name>New-RDSDBInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBName</name> <description> <para>The meaning of this parameter differs according to the database engine you use. Type: String <b>MySQL</b> The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Cannot be a word reserved by the specified database engine <b>MariaDB</b> The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Cannot be a word reserved by the specified database engine <b>PostgreSQL</b> The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance. Constraints: - Must contain 1 to 63 letters, numbers, or underscores. - Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9). - Cannot be a word reserved by the specified database engine <b>Oracle</b> The Oracle System ID (SID) of the created DB instance. If you specify <code>null</code>, the default value <code>ORCL</code> is used. You can't specify the string NULL, or any other reserved word, for <code>DBName</code>. Default: <code>ORCL</code> Constraints: - Cannot be longer than 8 characters <b>SQL Server</b> Not applicable. Must be null. <b>Amazon Aurora</b> The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Cannot be a word reserved by the specified database engine </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>mydbinstance</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllocatedStorage</name> <description> <para>The amount of storage (in gigabytes) to be initially allocated for the database instance. Type: Integer <b>Amazon Aurora</b> Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. <b>MySQL</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144. - Provisioned IOPS storage (io1): Must be an integer from 100 to 6144. - Magnetic storage (standard): Must be an integer from 5 to 3072. <b>MariaDB</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144. - Provisioned IOPS storage (io1): Must be an integer from 100 to 6144. - Magnetic storage (standard): Must be an integer from 5 to 3072. <b>PostgreSQL</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144. - Provisioned IOPS storage (io1): Must be an integer from 100 to 6144. - Magnetic storage (standard): Must be an integer from 5 to 3072. <b>Oracle</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144. - Provisioned IOPS storage (io1): Must be an integer from 100 to 6144. - Magnetic storage (standard): Must be an integer from 10 to 3072. <b>SQL Server</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): - Enterprise and Standard editions: Must be an integer from 200 to 16384. - Web and Express editions: Must be an integer from 20 to 16384. - Provisioned IOPS storage (io1): - Enterprise and Standard editions: Must be an integer from 200 to 16384. - Web and Express editions: Must be an integer from 100 to 16384. - Magnetic storage (standard): - Enterprise and Standard editions: Must be an integer from 200 to 1024. - Web and Express editions: Must be an integer from 20 to 1024. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para>Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para> The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions and Availability Zones</a>. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: <code>us-east-1d</code> Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to <code>true</code>. The specified Availability Zone must be in the same AWS Region as the current endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. <b>Amazon Aurora</b> Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. Default: 1 Constraints: - Must be a value from 0 to 35 - Cannot be set to 0 if the DB instance is a source to Read Replicas </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CharacterSetName</name> <description> <para>For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. <b>Amazon Aurora</b> Not applicable. The character set is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see <a>CreateDBCluster</a>. Type: String </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The compute and memory capacity of the DB instance. Note that not all instance classes are available in all regions for all DB engines. Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBSecurityGroup</name> <description> <para>A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Domain</name> <description> <para>Specify the Active Directory Domain to create the instance in. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DomainIAMRoleName</name> <description> <para>Specify the name of the IAM role to be used when making API calls to the Directory Service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines: <b>Amazon Aurora</b> Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. <b>MySQL</b> - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnablePerformanceInsight</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The name of the database engine to be used for this instance. Not every database engine is available for every AWS Region. Valid Values: - <code>aurora</code> - <code>mariadb</code> - <code>mysql</code> - <code>oracle-ee</code> - <code>oracle-se2</code> - <code>oracle-se1</code> - <code>oracle-se</code> - <code>postgres</code> - <code>sqlserver-ee</code> - <code>sqlserver-se</code> - <code>sqlserver-ex</code> - <code>sqlserver-web</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineVersion</name> <description> <para>The version number of the database engine to use. The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. <b>Amazon Aurora</b> Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. <b>MariaDB</b> - <code>10.1.23</code> (supported in all AWS regions) - <code>10.1.19</code> (supported in all AWS regions) - <code>10.1.14</code> (supported in all regions except us-east-2) - <code>10.0.31</code> (supported in all AWS regions) - <code>10.0.28</code> (supported in all AWS regions) - <code>10.0.24</code> (supported in all AWS regions) - <code>10.0.17</code> (supported in all regions except us-east-2, ca-central-1, eu-west-2) <b>Microsoft SQL Server 2016</b> - <code>13.00.4422.0.v1</code> (supported for all editions, and all AWS regions) - <code>13.00.2164.0.v1</code> (supported for all editions, and all AWS regions) <b>Microsoft SQL Server 2014</b> - <code>12.00.5546.0.v1</code> (supported for all editions, and all AWS regions) - <code>12.00.5000.0.v1</code> (supported for all editions, and all AWS regions) - <code>12.00.4422.0.v1</code> (supported for all editions except Enterprise Edition, and all AWS regions except ca-central-1 and eu-west-2) <b>Microsoft SQL Server 2012</b> - <code>11.00.6594.0.v1</code> (supported for all editions, and all AWS regions) - <code>11.00.6020.0.v1</code> (supported for all editions, and all AWS regions) - <code>11.00.5058.0.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) - <code>11.00.2100.60.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) <b>Microsoft SQL Server 2008 R2</b> - <code>10.50.6529.0.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) - <code>10.50.6000.34.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) - <code>10.50.2789.0.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) <b>MySQL</b> - <code>5.7.17</code> (supported in all AWS regions) - <code>5.7.16</code> (supported in all AWS regions) - <code>5.7.11</code> (supported in all AWS regions) - <code>5.6.35</code> (supported in all AWS regions) - <code>5.6.34</code> (supported in all AWS regions) - <code>5.6.29</code> (supported in all AWS regions) - <code>5.6.27</code> (supported in all regions except us-east-2, ca-central-1, eu-west-2) - <code>5.5.54</code> (supported in all AWS regions) - <code>5.5.53</code> (supported in all AWS regions) - <code>5.5.46</code> (supported in all AWS regions) <b>Oracle 12c</b> - <code>12.1.0.2.v8</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v7</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v6</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v5</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v4</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v3</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v2</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v1</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) <b>Oracle 11g</b> - <code>11.2.0.4.v12</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v11</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v10</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v9</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v8</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v7</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v6</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v5</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v4</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v3</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v1</code> (supported for EE, SE1, and SE, in all AWS regions) <b>PostgreSQL</b> - <b>Version 9.6.x:</b><code> 9.6.1 | 9.6.2 | 9.6.3</code> - <b>Version 9.5.x:</b><code>9.5.6 | 9.5.4 | 9.5.2</code> - <b>Version 9.4.x:</b><code>9.4.11 | 9.4.9 | 9.4.7</code> - <b>Version 9.3.x:</b><code>9.3.16 | 9.3.14 | 9.3.12</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Iops</name> <description> <para>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your <code>Iops</code> value can be 2000, 3000, 4000, or 5000. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. <b>Amazon Aurora</b> Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. If the <code>StorageEncrypted</code> parameter is true, and you do not specify a value for the <code>KmsKeyId</code> parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>License model information for this DB instance. Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUsername</name> <description> <para>The name for the master user. <b>Amazon Aurora</b> Not applicable. The name for the master user is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. <b>MariaDB</b> Constraints: - Required for MariaDB. - Must be 1 to 16 letters or numbers. - Cannot be a reserved word for the chosen database engine. <b>Microsoft SQL Server</b> Constraints: - Required for SQL Server. - Must be 1 to 128 letters or numbers. - The first character must be a letter. - Cannot be a reserved word for the chosen database engine. <b>MySQL</b> Constraints: - Required for MySQL. - Must be 1 to 16 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. <b>Oracle</b> Constraints: - Required for Oracle. - Must be 1 to 30 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. <b>PostgreSQL</b> Constraints: - Required for PostgreSQL. - Must be 1 to 63 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The password for the master user. Can be any printable ASCII character except "/", """, or "@". <b>Amazon Aurora</b> Not applicable. The password for the master user is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. <b>MariaDB</b> Constraints: Must contain from 8 to 41 characters. <b>Microsoft SQL Server</b> Constraints: Must contain from 8 to 128 characters. <b>MySQL</b> Constraints: Must contain from 8 to 41 characters. <b>Oracle</b> Constraints: Must contain from 8 to 30 characters. <b>PostgreSQL</b> Constraints: Must contain from 8 to 128 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringInterval</name> <description> <para>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0. Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringRoleArn</name> <description> <para>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling">Setting Up and Enabling Enhanced Monitoring</a>. If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MultiAZ</name> <description> <para>Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PerformanceInsightsKMSKeyId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the database accepts connections. <b>MySQL</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> Type: Integer <b>MariaDB</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> Type: Integer <b>PostgreSQL</b> Default: <code>5432</code> Valid Values: <code>1150-65535</code> Type: Integer <b>Oracle</b> Default: <code>1521</code> Valid Values: <code>1150-65535</code> <b>SQL Server</b> Default: <code>1433</code> Valid Values: <code>1150-65535</code> except for <code>1434</code>, <code>3389</code>, <code>47001</code>, <code>49152</code>, and <code>49152</code> through <code>49156</code>. <b>Amazon Aurora</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> Type: Integer </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para> The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.BackingUpAndRestoringAmazonRDSInstances.html">DB Instance Backups</a>. <b>Amazon Aurora</b> Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow"> Adjusting the Preferred DB Instance Maintenance Window</a>. Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para> The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBMaintenance.html">DB Instance Maintenance</a>. Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PromotionTier</name> <description> <para>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance"> Fault Tolerance for an Aurora DB Cluster</a>. Default: 1 Valid Values: 0 - 15 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. - <b>Default VPC:</b> true - <b>VPC:</b> false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageEncrypted</name> <description> <para>Specifies whether the DB instance is encrypted. <b>Amazon Aurora</b> Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the DB instance. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialArn</name> <description> <para>The ARN from the Key Store with which to associate the instance for TDE encryption. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialPassword</name> <description> <para>The password for the given ARN from the Key Store in order to access the device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Timezone</name> <description> <para>The time zone of the DB instance. The time zone parameter is currently supported only by <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone">Microsoft SQL Server</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of EC2 VPC security groups to associate with this DB instance. <b>Amazon Aurora</b> Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. Default: The default EC2 VPC security group for the DB subnet group's VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllocatedStorage</name> <description> <para>The amount of storage (in gigabytes) to be initially allocated for the database instance. Type: Integer <b>Amazon Aurora</b> Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. <b>MySQL</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144. - Provisioned IOPS storage (io1): Must be an integer from 100 to 6144. - Magnetic storage (standard): Must be an integer from 5 to 3072. <b>MariaDB</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144. - Provisioned IOPS storage (io1): Must be an integer from 100 to 6144. - Magnetic storage (standard): Must be an integer from 5 to 3072. <b>PostgreSQL</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144. - Provisioned IOPS storage (io1): Must be an integer from 100 to 6144. - Magnetic storage (standard): Must be an integer from 5 to 3072. <b>Oracle</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144. - Provisioned IOPS storage (io1): Must be an integer from 100 to 6144. - Magnetic storage (standard): Must be an integer from 10 to 3072. <b>SQL Server</b> Constraints to the amount of storage for each storage type are the following: - General Purpose (SSD) storage (gp2): - Enterprise and Standard editions: Must be an integer from 200 to 16384. - Web and Express editions: Must be an integer from 20 to 16384. - Provisioned IOPS storage (io1): - Enterprise and Standard editions: Must be an integer from 200 to 16384. - Web and Express editions: Must be an integer from 100 to 16384. - Magnetic storage (standard): - Enterprise and Standard editions: Must be an integer from 200 to 1024. - Web and Express editions: Must be an integer from 20 to 1024. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para>Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para> The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions and Availability Zones</a>. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: <code>us-east-1d</code> Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to <code>true</code>. The specified Availability Zone must be in the same AWS Region as the current endpoint. </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="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. <b>Amazon Aurora</b> Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. Default: 1 Constraints: - Must be a value from 0 to 35 - Cannot be set to 0 if the DB instance is a source to Read Replicas </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CharacterSetName</name> <description> <para>For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. <b>Amazon Aurora</b> Not applicable. The character set is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. </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="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see <a>CreateDBCluster</a>. Type: String </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>DBInstanceClass</name> <description> <para>The compute and memory capacity of the DB instance. Note that not all instance classes are available in all regions for all DB engines. Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> </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="2"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>mydbinstance</code> </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 (ByValue, )" position="1"> <name>DBName</name> <description> <para>The meaning of this parameter differs according to the database engine you use. Type: String <b>MySQL</b> The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Cannot be a word reserved by the specified database engine <b>MariaDB</b> The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Cannot be a word reserved by the specified database engine <b>PostgreSQL</b> The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance. Constraints: - Must contain 1 to 63 letters, numbers, or underscores. - Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9). - Cannot be a word reserved by the specified database engine <b>Oracle</b> The Oracle System ID (SID) of the created DB instance. If you specify <code>null</code>, the default value <code>ORCL</code> is used. You can't specify the string NULL, or any other reserved word, for <code>DBName</code>. Default: <code>ORCL</code> Constraints: - Cannot be longer than 8 characters <b>SQL Server</b> Not applicable. Must be null. <b>Amazon Aurora</b> The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Cannot be a word reserved by the specified database engine </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>DBParameterGroupName</name> <description> <para>The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </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="False" position="Named"> <name>DBSecurityGroup</name> <description> <para>A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. </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>DBSubnetGroupName</name> <description> <para>A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance. </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="False" position="Named"> <name>Domain</name> <description> <para>Specify the Active Directory Domain to create the instance in. </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="False" position="Named"> <name>DomainIAMRoleName</name> <description> <para>Specify the name of the IAM role to be used when making API calls to the Directory Service. </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines: <b>Amazon Aurora</b> Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. <b>MySQL</b> - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnablePerformanceInsight</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The name of the database engine to be used for this instance. Not every database engine is available for every AWS Region. Valid Values: - <code>aurora</code> - <code>mariadb</code> - <code>mysql</code> - <code>oracle-ee</code> - <code>oracle-se2</code> - <code>oracle-se1</code> - <code>oracle-se</code> - <code>postgres</code> - <code>sqlserver-ee</code> - <code>sqlserver-se</code> - <code>sqlserver-ex</code> - <code>sqlserver-web</code> </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>EngineVersion</name> <description> <para>The version number of the database engine to use. The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. <b>Amazon Aurora</b> Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. <b>MariaDB</b> - <code>10.1.23</code> (supported in all AWS regions) - <code>10.1.19</code> (supported in all AWS regions) - <code>10.1.14</code> (supported in all regions except us-east-2) - <code>10.0.31</code> (supported in all AWS regions) - <code>10.0.28</code> (supported in all AWS regions) - <code>10.0.24</code> (supported in all AWS regions) - <code>10.0.17</code> (supported in all regions except us-east-2, ca-central-1, eu-west-2) <b>Microsoft SQL Server 2016</b> - <code>13.00.4422.0.v1</code> (supported for all editions, and all AWS regions) - <code>13.00.2164.0.v1</code> (supported for all editions, and all AWS regions) <b>Microsoft SQL Server 2014</b> - <code>12.00.5546.0.v1</code> (supported for all editions, and all AWS regions) - <code>12.00.5000.0.v1</code> (supported for all editions, and all AWS regions) - <code>12.00.4422.0.v1</code> (supported for all editions except Enterprise Edition, and all AWS regions except ca-central-1 and eu-west-2) <b>Microsoft SQL Server 2012</b> - <code>11.00.6594.0.v1</code> (supported for all editions, and all AWS regions) - <code>11.00.6020.0.v1</code> (supported for all editions, and all AWS regions) - <code>11.00.5058.0.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) - <code>11.00.2100.60.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) <b>Microsoft SQL Server 2008 R2</b> - <code>10.50.6529.0.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) - <code>10.50.6000.34.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) - <code>10.50.2789.0.v1</code> (supported for all editions, and all AWS regions except us-east-2, ca-central-1, and eu-west-2) <b>MySQL</b> - <code>5.7.17</code> (supported in all AWS regions) - <code>5.7.16</code> (supported in all AWS regions) - <code>5.7.11</code> (supported in all AWS regions) - <code>5.6.35</code> (supported in all AWS regions) - <code>5.6.34</code> (supported in all AWS regions) - <code>5.6.29</code> (supported in all AWS regions) - <code>5.6.27</code> (supported in all regions except us-east-2, ca-central-1, eu-west-2) - <code>5.5.54</code> (supported in all AWS regions) - <code>5.5.53</code> (supported in all AWS regions) - <code>5.5.46</code> (supported in all AWS regions) <b>Oracle 12c</b> - <code>12.1.0.2.v8</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v7</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v6</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v5</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v4</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v3</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v2</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) - <code>12.1.0.2.v1</code> (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1) <b>Oracle 11g</b> - <code>11.2.0.4.v12</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v11</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v10</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v9</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v8</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v7</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v6</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v5</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v4</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v3</code> (supported for EE, SE1, and SE, in all AWS regions) - <code>11.2.0.4.v1</code> (supported for EE, SE1, and SE, in all AWS regions) <b>PostgreSQL</b> - <b>Version 9.6.x:</b><code> 9.6.1 | 9.6.2 | 9.6.3</code> - <b>Version 9.5.x:</b><code>9.5.6 | 9.5.4 | 9.5.2</code> - <b>Version 9.4.x:</b><code>9.4.11 | 9.4.9 | 9.4.7</code> - <b>Version 9.3.x:</b><code>9.3.16 | 9.3.14 | 9.3.12</code> </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="False" 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="False" position="Named"> <name>Iops</name> <description> <para>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your <code>Iops</code> value can be 2000, 3000, 4000, or 5000. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. <b>Amazon Aurora</b> Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. If the <code>StorageEncrypted</code> parameter is true, and you do not specify a value for the <code>KmsKeyId</code> parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. </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="False" position="Named"> <name>LicenseModel</name> <description> <para>License model information for this DB instance. Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </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="False" position="Named"> <name>MasterUsername</name> <description> <para>The name for the master user. <b>Amazon Aurora</b> Not applicable. The name for the master user is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. <b>MariaDB</b> Constraints: - Required for MariaDB. - Must be 1 to 16 letters or numbers. - Cannot be a reserved word for the chosen database engine. <b>Microsoft SQL Server</b> Constraints: - Required for SQL Server. - Must be 1 to 128 letters or numbers. - The first character must be a letter. - Cannot be a reserved word for the chosen database engine. <b>MySQL</b> Constraints: - Required for MySQL. - Must be 1 to 16 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. <b>Oracle</b> Constraints: - Required for Oracle. - Must be 1 to 30 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. <b>PostgreSQL</b> Constraints: - Required for PostgreSQL. - Must be 1 to 63 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. </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="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The password for the master user. Can be any printable ASCII character except "/", """, or "@". <b>Amazon Aurora</b> Not applicable. The password for the master user is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. <b>MariaDB</b> Constraints: Must contain from 8 to 41 characters. <b>Microsoft SQL Server</b> Constraints: Must contain from 8 to 128 characters. <b>MySQL</b> Constraints: Must contain from 8 to 41 characters. <b>Oracle</b> Constraints: Must contain from 8 to 30 characters. <b>PostgreSQL</b> Constraints: Must contain from 8 to 128 characters. </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="False" position="Named"> <name>MonitoringInterval</name> <description> <para>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0. Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringRoleArn</name> <description> <para>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling">Setting Up and Enabling Enhanced Monitoring</a>. If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value. </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="False" position="Named"> <name>MultiAZ</name> <description> <para>Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </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="False" position="Named"> <name>PerformanceInsightsKMSKeyId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the database accepts connections. <b>MySQL</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> Type: Integer <b>MariaDB</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> Type: Integer <b>PostgreSQL</b> Default: <code>5432</code> Valid Values: <code>1150-65535</code> Type: Integer <b>Oracle</b> Default: <code>1521</code> Valid Values: <code>1150-65535</code> <b>SQL Server</b> Default: <code>1433</code> Valid Values: <code>1150-65535</code> except for <code>1434</code>, <code>3389</code>, <code>47001</code>, <code>49152</code>, and <code>49152</code> through <code>49156</code>. <b>Amazon Aurora</b> Default: <code>3306</code> Valid Values: <code>1150-65535</code> Type: Integer </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para> The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.BackingUpAndRestoringAmazonRDSInstances.html">DB Instance Backups</a>. <b>Amazon Aurora</b> Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow"> Adjusting the Preferred DB Instance Maintenance Window</a>. Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </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="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para> The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBMaintenance.html">DB Instance Maintenance</a>. Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. </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="False" position="Named"> <name>PromotionTier</name> <description> <para>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance"> Fault Tolerance for an Aurora DB Cluster</a>. Default: 1 Valid Values: 0 - 15 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. - <b>Default VPC:</b> true - <b>VPC:</b> false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageEncrypted</name> <description> <para>Specifies whether the DB instance is encrypted. <b>Amazon Aurora</b> Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. Default: false </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the DB instance. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialArn</name> <description> <para>The ARN from the Key Store with which to associate the instance for TDE encryption. </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="False" position="Named"> <name>TdeCredentialPassword</name> <description> <para>The password for the given ARN from the Key Store in order to access the device. </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="False" position="Named"> <name>Timezone</name> <description> <para>The time zone of the DB instance. The time zone parameter is currently supported only by <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone">Microsoft SQL Server</a>. </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="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of EC2 VPC security groups to associate with this DB instance. <b>Amazon Aurora</b> Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>. Default: The default EC2 VPC security group for the DB subnet group's VPC. </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.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.CreateDBInstanceResponse) 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=New-RDSDBInstance.html&tocid=New-RDSDBInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBInstanceReadReplica</name> <description> <para>Invokes the CreateDBInstanceReadReplica operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBInstanceReadReplica</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. Amazon Aurora does not support this action. You must call the <code>CreateDBInstance</code> action to create a DB instance for an Aurora DB cluster. All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below. <important><para> The source DB instance must have backup retention enabled. </para></important> For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working with PostgreSQL, MySQL, and MariaDB Read Replicas</a>. </para> </description> <syntax> <syntaxItem> <name>New-RDSDBInstanceReadReplica</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SourceDBInstanceIdentifier</name> <description> <para>The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas. Constraints: - Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance. - Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6. - Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication). - The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0. - If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier. - If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing a Amazon RDS Amazon Resource Name (ARN)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para>Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The Amazon EC2 Availability Zone that the Read Replica will be created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: <code>us-east-1d</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The compute and memory capacity of the Read Replica. Note that not all instance classes are available in all regions for all DB engines. Valid Values: <code>db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> Default: Inherits from the source DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC. Constraints: - Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region. - If supplied, must match the name of an existing DBSubnetGroup. - The specified DB subnet group must be in the same AWS Region in which the operation is running. - All Read Replicas in one AWS Region that are created from the same source DB instance must either:> - Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC. - Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher - Aurora 5.6 or higher. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnablePerformanceInsight</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Iops</name> <description> <para>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted. If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance. If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringInterval</name> <description> <para>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0. Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringRoleArn</name> <description> <para>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To create an IAM role for Amazon RDS Enhanced Monitoring</a>. If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> 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>OptionGroupName</name> <description> <para>The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PerformanceInsightsKMSKeyId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: <code>1150-65535</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreSignedUrl</name> <description> <para>The URL that contains a Signature Version 4 signed request for the <code>CreateDBInstanceReadReplica</code> API action in the source AWS Region that contains the source DB instance. You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the source region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the <code>CreateDBInstanceReadReplica</code> API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: - <code>DestinationRegion</code> - The AWS Region that the encrypted Read Replica will be created in. This AWS Region is the same one where the <code>CreateDBInstanceReadReplica</code> action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 region, from a source DB instance in the us-east-2 region, then you call the <code>CreateDBInstanceReadReplica</code> action in the us-east-1 region and provide a presigned URL that contains a call to the <code>CreateDBInstanceReadReplica</code> action in the us-west-2 region. For this example, the <code>DestinationRegion</code> in the presigned URL must be set to the us-east-1 region. - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the <code>CreateDBInstanceReadReplica</code> action that is called in the destination AWS Region, and the action contained in the presigned URL. - <code>SourceDBInstanceIdentifier</code> - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 region, then your <code>SourceDBInstanceIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. - <b>Default VPC:</b>true - <b>VPC:</b>false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceRegion</name> <description> <para> The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the Read Replica. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para>Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The Amazon EC2 Availability Zone that the Read Replica will be created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: <code>us-east-1d</code> </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="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The compute and memory capacity of the Read Replica. Note that not all instance classes are available in all regions for all DB engines. Valid Values: <code>db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> Default: Inherits from the source DB instance. </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 (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string. </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>DBSubnetGroupName</name> <description> <para>Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC. Constraints: - Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region. - If supplied, must match the name of an existing DBSubnetGroup. - The specified DB subnet group must be in the same AWS Region in which the operation is running. - All Read Replicas in one AWS Region that are created from the same source DB instance must either:> - Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC. - Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC. Example: <code>mySubnetgroup</code> </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher - Aurora 5.6 or higher. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnablePerformanceInsight</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Iops</name> <description> <para>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted. If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance. If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region. </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="False" position="Named"> <name>MonitoringInterval</name> <description> <para>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0. Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MonitoringRoleArn</name> <description> <para>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole">To create an IAM role for Amazon RDS Enhanced Monitoring</a>. If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value. </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>OptionGroupName</name> <description> <para>The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used. </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="False" position="Named"> <name>PerformanceInsightsKMSKeyId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Port</name> <description> <para>The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: <code>1150-65535</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreSignedUrl</name> <description> <para>The URL that contains a Signature Version 4 signed request for the <code>CreateDBInstanceReadReplica</code> API action in the source AWS Region that contains the source DB instance. You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the source region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the <code>CreateDBInstanceReadReplica</code> API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: - <code>DestinationRegion</code> - The AWS Region that the encrypted Read Replica will be created in. This AWS Region is the same one where the <code>CreateDBInstanceReadReplica</code> action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 region, from a source DB instance in the us-east-2 region, then you call the <code>CreateDBInstanceReadReplica</code> action in the us-east-1 region and provide a presigned URL that contains a call to the <code>CreateDBInstanceReadReplica</code> action in the us-west-2 region. For this example, the <code>DestinationRegion</code> in the presigned URL must be set to the us-east-1 region. - <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the <code>CreateDBInstanceReadReplica</code> action that is called in the destination AWS Region, and the action contained in the presigned URL. - <code>SourceDBInstanceIdentifier</code> - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 region, then your <code>SourceDBInstanceIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115</code>. To learn how to generate a Signature Version 4 signed request, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </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="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. - <b>Default VPC:</b>true - <b>VPC:</b>false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SourceDBInstanceIdentifier</name> <description> <para>The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas. Constraints: - Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance. - Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6. - Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross region replication). - The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0. - If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier. - If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing a Amazon RDS Amazon Resource Name (ARN)</a>. </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="False" position="Named"> <name>SourceRegion</name> <description> <para> The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. </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="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the Read Replica. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.CreateDBInstanceReadReplicaResponse) 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=New-RDSDBInstanceReadReplica.html&tocid=New-RDSDBInstanceReadReplica</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBParameterGroup</name> <description> <para>Invokes the CreateDBParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <i>ModifyDBParameterGroup</i>. Once you've created a DB parameter group, you need to associate it with your DB instance using <i>ModifyDBInstance</i>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. <important><para> After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified. </para></important> </para> </description> <syntax> <syntaxItem> <name>New-RDSDBParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Description</name> <description> <para>The description for the DB parameter group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBParameterGroupFamily</name> <description> <para>The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBParameterGroupFamily</name> <description> <para>The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. </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 (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. </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="False" position="2"> <name>Description</name> <description> <para>The description for the DB parameter group. </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="False" 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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBParameterGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBParameterGroup object. The service call response (type Amazon.RDS.Model.CreateDBParameterGroupResponse) 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=New-RDSDBParameterGroup.html&tocid=New-RDSDBParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBSecurityGroup</name> <description> <para>Invokes the CreateDBSecurityGroup operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBSecurityGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new DB security group. DB security groups control access to a DB instance. </para> </description> <syntax> <syntaxItem> <name>New-RDSDBSecurityGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name for the DB security group. This value is stored as a lowercase string. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens - Must not be "Default" Example: <code>mysecuritygroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DBSecurityGroupDescription</name> <description> <para>The description for the DB security group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DBSecurityGroupDescription</name> <description> <para>The description for the DB security group. </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 (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name for the DB security group. This value is stored as a lowercase string. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens - Must not be "Default" Example: <code>mysecuritygroup</code> </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="False" 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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBSecurityGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSecurityGroup object. The service call response (type Amazon.RDS.Model.CreateDBSecurityGroupResponse) 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=New-RDSDBSecurityGroup.html&tocid=New-RDSDBSecurityGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBSnapshot</name> <description> <para>Invokes the CreateDBSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a DBSnapshot. The source DBInstance must be in "available" state. </para> </description> <syntax> <syntaxItem> <name>New-RDSDBSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-snapshot-id</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DBInstanceIdentifier</name> <description> <para>The identifier of the DB instance that you want to create the snapshot of. Constraints: - Must match the identifier of an existing DBInstance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DBInstanceIdentifier</name> <description> <para>The identifier of the DB instance that you want to create the snapshot of. Constraints: - Must match the identifier of an existing DBInstance. </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 (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot. Constraints: - Cannot be null, empty, or blank - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-snapshot-id</code> </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="False" 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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSnapshot object. The service call response (type Amazon.RDS.Model.CreateDBSnapshotResponse) 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=New-RDSDBSnapshot.html&tocid=New-RDSDBSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSDBSubnetGroup</name> <description> <para>Invokes the CreateDBSubnetGroup operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSDBSubnetGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region. </para> </description> <syntax> <syntaxItem> <name>New-RDSDBSubnetGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSubnetGroupName</name> <description> <para>The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DBSubnetGroupDescription</name> <description> <para>The description for the DB subnet group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SubnetId</name> <description> <para>The EC2 Subnet IDs for the DB subnet group. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DBSubnetGroupDescription</name> <description> <para>The description for the DB subnet group. </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 (ByValue, ByPropertyName)" position="1"> <name>DBSubnetGroupName</name> <description> <para>The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: <code>mySubnetgroup</code> </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="False" 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="False" position="3"> <name>SubnetId</name> <description> <para>The EC2 Subnet IDs for the DB subnet group. </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBSubnetGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSubnetGroup object. The service call response (type Amazon.RDS.Model.CreateDBSubnetGroupResponse) 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=New-RDSDBSubnetGroup.html&tocid=New-RDSDBSubnetGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSEventSubscription</name> <description> <para>Invokes the CreateEventSubscription operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSEventSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account. </para> </description> <syntax> <syntaxItem> <name>New-RDSEventSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the subscription. Constraints: The name must be less than 255 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: <code>db-instance</code> | <code>db-cluster</code> | <code>db-parameter-group</code> | <code>db-security-group</code> | <code>db-snapshot</code> | <code>db-cluster-snapshot</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para> A Boolean value; set to <b>true</b> to activate the subscription, set to <b>false</b> to create the subscription but not active it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceId</name> <description> <para>The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. Constraints: - If SourceIds are supplied, SourceType must also be provided. - If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied. - If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied. - If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied. - If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Enabled</name> <description> <para> A Boolean value; set to <b>true</b> to activate the subscription, set to <b>false</b> to create the subscription but not active it. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EventCategory</name> <description> <para> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </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="False" 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="2"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </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="False" position="Named"> <name>SourceId</name> <description> <para>The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. Constraints: - If SourceIds are supplied, SourceType must also be provided. - If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied. - If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied. - If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied. - If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied. </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="False" position="3"> <name>SourceType</name> <description> <para>The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: <code>db-instance</code> | <code>db-cluster</code> | <code>db-parameter-group</code> | <code>db-security-group</code> | <code>db-snapshot</code> | <code>db-cluster-snapshot</code> </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 (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the subscription. Constraints: The name must be less than 255 characters. </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventSubscription object. The service call response (type Amazon.RDS.Model.CreateEventSubscriptionResponse) 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=New-RDSEventSubscription.html&tocid=New-RDSEventSubscription</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>New-RDSOptionGroup</name> <description> <para>Invokes the CreateOptionGroup operation against Amazon Relational Database Service.</para> </description> <verb>New</verb> <noun>RDSOptionGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new option group. You can create up to 20 option groups. </para> </description> <syntax> <syntaxItem> <name>New-RDSOptionGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>OptionGroupName</name> <description> <para>Specifies the name of the option group to be created. Constraints: - Must be 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>myoptiongroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>EngineName</name> <description> <para>Specifies the name of the engine that this option group should be associated with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>MajorEngineVersion</name> <description> <para>Specifies the major version of the engine that this option group should be associated with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>OptionGroupDescription</name> <description> <para>The description of the option group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>EngineName</name> <description> <para>Specifies the name of the engine that this option group should be associated with. </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="False" 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="False" position="3"> <name>MajorEngineVersion</name> <description> <para>Specifies the major version of the engine that this option group should be associated with. </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="False" position="4"> <name>OptionGroupDescription</name> <description> <para>The description of the option group. </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 (ByValue, ByPropertyName)" position="1"> <name>OptionGroupName</name> <description> <para>Specifies the name of the option group to be created. Constraints: - Must be 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>myoptiongroup</code> </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.OptionGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a OptionGroup object. The service call response (type Amazon.RDS.Model.CreateOptionGroupResponse) 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=New-RDSOptionGroup.html&tocid=New-RDSOptionGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSDBCluster</name> <description> <para>Invokes the DeleteDBCluster operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSDBCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Remove-RDSDBCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: - Must match an existing DBClusterIdentifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FinalDBSnapshotIdentifier</name> <description> <para> The DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is set to <code>false</code>. Specifying this parameter and also setting the <code>SkipFinalShapshot</code> parameter to true results in an error. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SkipFinalSnapshot</name> <description> <para> Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If <code>true</code> is specified, no DB cluster snapshot is created. If <code>false</code> is specified, a DB cluster snapshot is created before the DB cluster is deleted. You must specify a <code>FinalDBSnapshotIdentifier</code> parameter if <code>SkipFinalSnapshot</code> is <code>false</code>. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: - Must match an existing DBClusterIdentifier. </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="False" position="Named"> <name>FinalDBSnapshotIdentifier</name> <description> <para> The DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is set to <code>false</code>. Specifying this parameter and also setting the <code>SkipFinalShapshot</code> parameter to true results in an error. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </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="False" 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="False" position="Named"> <name>SkipFinalSnapshot</name> <description> <para> Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If <code>true</code> is specified, no DB cluster snapshot is created. If <code>false</code> is specified, a DB cluster snapshot is created before the DB cluster is deleted. You must specify a <code>FinalDBSnapshotIdentifier</code> parameter if <code>SkipFinalSnapshot</code> is <code>false</code>. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBCluster object. The service call response (type Amazon.RDS.Model.DeleteDBClusterResponse) 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=Remove-RDSDBCluster.html&tocid=Remove-RDSDBCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSDBClusterParameterGroup</name> <description> <para>Invokes the DeleteDBClusterParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSDBClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Remove-RDSDBClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group. Constraints: - Must be the name of an existing DB cluster parameter group. - You cannot delete a default DB cluster parameter group. - Cannot be associated with any DB clusters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBClusterParameterGroupName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group. Constraints: - Must be the name of an existing DB cluster parameter group. - You cannot delete a default DB cluster parameter group. - Cannot be associated with any DB clusters. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBClusterParameterGroupName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DBClusterParameterGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.DeleteDBClusterParameterGroupResponse) 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-RDSDBClusterParameterGroup.html&tocid=Remove-RDSDBClusterParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSDBClusterSnapshot</name> <description> <para>Invokes the DeleteDBClusterSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSDBClusterSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the <code>available</code> state to be deleted. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Remove-RDSDBClusterSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterSnapshotIdentifier</name> <description> <para>The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the <code>available</code> state. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterSnapshotIdentifier</name> <description> <para>The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the <code>available</code> state. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBClusterSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBClusterSnapshot object. The service call response (type Amazon.RDS.Model.DeleteDBClusterSnapshotResponse) 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=Remove-RDSDBClusterSnapshot.html&tocid=Remove-RDSDBClusterSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSDBInstance</name> <description> <para>Invokes the DeleteDBInstance operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSDBInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted. If you request a final DB snapshot the status of the Amazon RDS DB instance is <code>deleting</code> until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, you can only delete it when the <code>SkipFinalSnapshot</code> parameter is set to <code>true</code>. If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if both of the following conditions are true: - The DB cluster is a Read Replica of another Amazon Aurora DB cluster. - The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the <a>PromoteReadReplicaDBCluster</a> API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the <code>DeleteDBInstance</code> API action to delete the final instance in the DB cluster. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSDBInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. Constraints: - Must match the name of an existing DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FinalDBSnapshotIdentifier</name> <description> <para> The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to <code>false</code>. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: - Must be 1 to 255 letters or numbers. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens - Cannot be specified when deleting a Read Replica. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SkipFinalSnapshot</name> <description> <para> Determines whether a final DB snapshot is created before the DB instance is deleted. If <code>true</code> is specified, no DBSnapshot is created. If <code>false</code> is specified, a DB snapshot is created before the DB instance is deleted. Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". Specify <code>true</code> when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is <code>false</code>. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. Constraints: - Must match the name of an existing DB instance. </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="False" position="Named"> <name>FinalDBSnapshotIdentifier</name> <description> <para> The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to <code>false</code>. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: - Must be 1 to 255 letters or numbers. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens - Cannot be specified when deleting a Read Replica. </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="False" 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="False" position="Named"> <name>SkipFinalSnapshot</name> <description> <para> Determines whether a final DB snapshot is created before the DB instance is deleted. If <code>true</code> is specified, no DBSnapshot is created. If <code>false</code> is specified, a DB snapshot is created before the DB instance is deleted. Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". Specify <code>true</code> when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is <code>false</code>. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.DeleteDBInstanceResponse) 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=Remove-RDSDBInstance.html&tocid=Remove-RDSDBInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSDBParameterGroup</name> <description> <para>Invokes the DeleteDBParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSDBParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSDBParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group. Constraints: - Must be the name of an existing DB parameter group - You cannot delete a default DB parameter group - Cannot be associated with any DB instances </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBParameterGroupName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group. Constraints: - Must be the name of an existing DB parameter group - You cannot delete a default DB parameter group - Cannot be associated with any DB instances </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBParameterGroupName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DBParameterGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.DeleteDBParameterGroupResponse) 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-RDSDBParameterGroup.html&tocid=Remove-RDSDBParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSDBSecurityGroup</name> <description> <para>Invokes the DeleteDBSecurityGroup operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSDBSecurityGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a DB security group. The specified DB security group must not be associated with any DB instances. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSDBSecurityGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name of the DB security group to delete. You cannot delete the default DB security group. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens - Must not be "Default" </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBSecurityGroupName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name of the DB security group to delete. You cannot delete the default DB security group. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens - Must not be "Default" </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBSecurityGroupName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DBSecurityGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.DeleteDBSecurityGroupResponse) 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-RDSDBSecurityGroup.html&tocid=Remove-RDSDBSecurityGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSDBSnapshot</name> <description> <para>Invokes the DeleteDBSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSDBSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated. The DBSnapshot must be in the <code>available</code> state to be deleted. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSDBSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The DBSnapshot identifier. Constraints: Must be the name of an existing DB snapshot in the <code>available</code> state. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSnapshotIdentifier</name> <description> <para>The DBSnapshot identifier. Constraints: Must be the name of an existing DB snapshot in the <code>available</code> state. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBSnapshot</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSnapshot object. The service call response (type Amazon.RDS.Model.DeleteDBSnapshotResponse) 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=Remove-RDSDBSnapshot.html&tocid=Remove-RDSDBSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSDBSubnetGroup</name> <description> <para>Invokes the DeleteDBSubnetGroup operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSDBSubnetGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSDBSubnetGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSubnetGroupName</name> <description> <para>The name of the database subnet group to delete. You cannot delete the default subnet group. Constraints: Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBSubnetGroupName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSubnetGroupName</name> <description> <para>The name of the database subnet group to delete. You cannot delete the default subnet group. Constraints: Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: <code>mySubnetgroup</code> </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBSubnetGroupName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DBSubnetGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.DeleteDBSubnetGroupResponse) 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-RDSDBSubnetGroup.html&tocid=Remove-RDSDBSubnetGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSEventSubscription</name> <description> <para>Invokes the DeleteEventSubscription operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSEventSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an RDS event notification subscription. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSEventSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription you want to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription you want to delete. </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.RDS.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventSubscription object. The service call response (type Amazon.RDS.Model.DeleteEventSubscriptionResponse) 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=Remove-RDSEventSubscription.html&tocid=Remove-RDSEventSubscription</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSOptionGroup</name> <description> <para>Invokes the DeleteOptionGroup operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSOptionGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an existing option group. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSOptionGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>OptionGroupName</name> <description> <para>The name of the option group to be deleted. You cannot delete default option groups. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the OptionGroupName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>OptionGroupName</name> <description> <para>The name of the option group to be deleted. You cannot delete default option groups. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the OptionGroupName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the OptionGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.DeleteOptionGroupResponse) 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-RDSOptionGroup.html&tocid=Remove-RDSOptionGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSRoleFromDBCluster</name> <description> <para>Invokes the RemoveRoleFromDBCluster operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSRoleFromDBCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Authorizing.AWSServices.html">Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSRoleFromDBCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the DB cluster to disassociate the IAM role from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example <code>arn:aws:iam::123456789012:role/AuroraAccessRole</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBClusterIdentifier parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the DB cluster to disassociate the IAM role from. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DBClusterIdentifier parameter. By default, this cmdlet does not generate any output. </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="False" position="2"> <name>RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example <code>arn:aws:iam::123456789012:role/AuroraAccessRole</code>. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DBClusterIdentifier parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.RemoveRoleFromDBClusterResponse) 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-RDSRoleFromDBCluster.html&tocid=Remove-RDSRoleFromDBCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSSourceIdentifierFromSubscription</name> <description> <para>Invokes the RemoveSourceIdentifierFromSubscription operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSSourceIdentifierFromSubscription</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes a source identifier from an existing RDS event notification subscription. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSSourceIdentifierFromSubscription</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription you want to remove a source identifier from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>SourceIdentifier</name> <description> <para> The source identifier to be removed from the subscription, such as the <b>DB instance identifier</b> for a DB instance or the name of a security group. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="2"> <name>SourceIdentifier</name> <description> <para> The source identifier to be removed from the subscription, such as the <b>DB instance identifier</b> for a DB instance or the name of a security group. </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 (ByValue, ByPropertyName)" position="1"> <name>SubscriptionName</name> <description> <para>The name of the RDS event notification subscription you want to remove a source identifier from. </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.RDS.Model.EventSubscription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventSubscription object. The service call response (type Amazon.RDS.Model.RemoveSourceIdentifierFromSubscriptionResponse) 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=Remove-RDSSourceIdentifierFromSubscription.html&tocid=Remove-RDSSourceIdentifierFromSubscription</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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-RDSTagFromResource</name> <description> <para>Invokes the RemoveTagsFromResource operation against Amazon Relational Database Service.</para> </description> <verb>Remove</verb> <noun>RDSTagFromResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-RDSTagFromResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ResourceName</name> <description> <para>The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TagKey</name> <description> <para>The tag key (name) of the tag to be removed. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the collection of tag keys that were removed. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the collection of tag keys that were removed. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>ResourceName</name> <description> <para>The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. </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="False" position="2"> <name>TagKey</name> <description> <para>The tag key (name) of the tag to be removed. </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 System.String</name> <uri /> <description /> </type> <description> <para>Returns the collection of tag keys that were removed when you use the PassThru parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.RDS.Model.RemoveTagsFromResourceResponse) 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-RDSTagFromResource.html&tocid=Remove-RDSTagFromResource</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Reset-RDSDBClusterParameterGroup</name> <description> <para>Invokes the ResetDBClusterParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>Reset</verb> <noun>RDSDBClusterParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <a>RebootDBInstance</a> request. You must call <a>RebootDBInstance</a> for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Reset-RDSDBClusterParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group to reset. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Parameter</name> <description> <para>A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the <code>ResetAllParameters</code> parameter is set to <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Parameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResetAllParameter</name> <description> <para>A value that is set to <code>true</code> to reset all parameters in the DB cluster parameter group to their default values, and <code>false</code> otherwise. You cannot use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group to reset. </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="False" 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="False" position="2"> <name>Parameter</name> <description> <para>A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the <code>ResetAllParameters</code> parameter is set to <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Parameter[]</parameterValue> <type> <name>Amazon.RDS.Model.Parameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResetAllParameter</name> <description> <para>A value that is set to <code>true</code> to reset all parameters in the DB cluster parameter group to their default values, and <code>false</code> otherwise. You cannot use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.RDS.Model.ResetDBClusterParameterGroupResponse) 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=Reset-RDSDBClusterParameterGroup.html&tocid=Reset-RDSDBClusterParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Reset-RDSDBParameterGroup</name> <description> <para>Invokes the ResetDBParameterGroup operation against Amazon Relational Database Service.</para> </description> <verb>Reset</verb> <noun>RDSDBParameterGroup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. </para> </description> <syntax> <syntaxItem> <name>Reset-RDSDBParameterGroup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group. Constraints: - Must match the name of an existing DBParameterGroup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Parameter</name> <description> <para>To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. To reset specific parameters, provide a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. <b>MySQL</b> Valid Values (for Apply method): <code>immediate</code> | <code>pending-reboot</code> You can use the immediate value with dynamic parameters only. You can use the <code>pending-reboot</code> value for both dynamic and static parameters, and changes are applied when DB instance reboots. <b>MariaDB</b> Valid Values (for Apply method): <code>immediate</code> | <code>pending-reboot</code> You can use the immediate value with dynamic parameters only. You can use the <code>pending-reboot</code> value for both dynamic and static parameters, and changes are applied when DB instance reboots. <b>Oracle</b> Valid Values (for Apply method): <code>pending-reboot</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Parameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResetAllParameter</name> <description> <para> Specifies whether (<code>true</code>) or not (<code>false</code>) to reset all parameters in the DB parameter group to default values. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBParameterGroupName</name> <description> <para>The name of the DB parameter group. Constraints: - Must match the name of an existing DBParameterGroup. </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="False" 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="False" position="Named"> <name>Parameter</name> <description> <para>To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. To reset specific parameters, provide a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. <b>MySQL</b> Valid Values (for Apply method): <code>immediate</code> | <code>pending-reboot</code> You can use the immediate value with dynamic parameters only. You can use the <code>pending-reboot</code> value for both dynamic and static parameters, and changes are applied when DB instance reboots. <b>MariaDB</b> Valid Values (for Apply method): <code>immediate</code> | <code>pending-reboot</code> You can use the immediate value with dynamic parameters only. You can use the <code>pending-reboot</code> value for both dynamic and static parameters, and changes are applied when DB instance reboots. <b>Oracle</b> Valid Values (for Apply method): <code>pending-reboot</code> </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Parameter[]</parameterValue> <type> <name>Amazon.RDS.Model.Parameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResetAllParameter</name> <description> <para> Specifies whether (<code>true</code>) or not (<code>false</code>) to reset all parameters in the DB parameter group to default values. Default: <code>true</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.RDS.Model.ResetDBParameterGroupResponse) 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=Reset-RDSDBParameterGroup.html&tocid=Reset-RDSDBParameterGroup</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Restart-RDSDBInstance</name> <description> <para>Invokes the RebootDBInstance operation against Amazon Relational Database Service.</para> </description> <verb>Restart</verb> <noun>RDSDBInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed. If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs. The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions. </para> </description> <syntax> <syntaxItem> <name>Restart-RDSDBInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier. This parameter is stored as a lowercase string. Constraints: - Must match the identifier of an existing DBInstance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ForceFailover</name> <description> <para> When <code>true</code>, the reboot will be conducted through a MultiAZ failover. Constraint: You cannot specify <code>true</code> if the instance is not configured for MultiAZ. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>The DB instance identifier. This parameter is stored as a lowercase string. Constraints: - Must match the identifier of an existing DBInstance. </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="False" 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="False" position="Named"> <name>ForceFailover</name> <description> <para> When <code>true</code>, the reboot will be conducted through a MultiAZ failover. Constraint: You cannot specify <code>true</code> if the instance is not configured for MultiAZ. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.RebootDBInstanceResponse) 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=Restart-RDSDBInstance.html&tocid=Restart-RDSDBInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Restore-RDSDBClusterFromS3</name> <description> <para>Invokes the RestoreDBClusterFromS3 operation against Amazon Relational Database Service.</para> </description> <verb>Restore</verb> <noun>RDSDBClusterFromS3</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Migrate.MySQL.html#Aurora.Migrate.MySQL.S3">Migrating Data from MySQL by Using an Amazon S3 Bucket</a>. </para> </description> <syntax> <syntaxItem> <name>Restore-RDSDBClusterFromS3</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>my-cluster1</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>A list of EC2 Availability Zones that instances in the restored DB cluster can be created in. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1. Default: 1 Constraints: - Must be a value from 1 to 35 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CharacterSetName</name> <description> <para>A value that indicates that the restored DB cluster should be associated with the specified CharacterSet. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DatabaseName</name> <description> <para>The database name for the restored DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, <code>default.aurora5.6</code> will be used. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>A DB subnet group to associate with the restored DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The name of the database engine to be used for the restored DB cluster. Valid Values: <code>aurora</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineVersion</name> <description> <para>The version number of the database engine to use. <b>Aurora</b> Example: <code>5.6.10a</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the <code>StorageEncrypted</code> parameter is true, and you do not specify a value for the <code>KmsKeyId</code> parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUsername</name> <description> <para>The name of the master user for the restored DB cluster. Constraints: - Must be 1 to 16 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the instances in the restored DB cluster accept connections. Default: <code>3306</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3BucketName</name> <description> <para>The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3IngestionRoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>S3Prefix</name> <description> <para>The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a <b>SourceS3Prefix</b> value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceEngine</name> <description> <para>The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: <code>mysql</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceEngineVersion</name> <description> <para>The version of the database that the backup files were created from. MySQL version 5.5 and 5.6 are supported. Example: <code>5.6.22</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageEncrypted</name> <description> <para>Specifies whether the restored DB cluster is encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of EC2 VPC security groups to associate with the restored DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>A list of EC2 Availability Zones that instances in the restored DB cluster can be created in. </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="False" position="Named"> <name>BackupRetentionPeriod</name> <description> <para>The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1. Default: 1 Constraints: - Must be a value from 1 to 35 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CharacterSetName</name> <description> <para>A value that indicates that the restored DB cluster should be associated with the specified CharacterSet. </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="False" position="Named"> <name>DatabaseName</name> <description> <para>The database name for the restored DB cluster. </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 (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. Example: <code>my-cluster1</code> </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="False" position="Named"> <name>DBClusterParameterGroupName</name> <description> <para>The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, <code>default.aurora5.6</code> will be used. Constraints: - If supplied, must match the name of an existing DBClusterParameterGroup. </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>DBSubnetGroupName</name> <description> <para>A DB subnet group to associate with the restored DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The name of the database engine to be used for the restored DB cluster. Valid Values: <code>aurora</code> </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>EngineVersion</name> <description> <para>The version number of the database engine to use. <b>Aurora</b> Example: <code>5.6.10a</code> </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="False" 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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the <code>StorageEncrypted</code> parameter is true, and you do not specify a value for the <code>KmsKeyId</code> parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. </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="False" position="Named"> <name>MasterUsername</name> <description> <para>The name of the master user for the restored DB cluster. Constraints: - Must be 1 to 16 letters or numbers. - First character must be a letter. - Cannot be a reserved word for the chosen database engine. </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="False" position="Named"> <name>MasterUserPassword</name> <description> <para>The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. </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>OptionGroupName</name> <description> <para>A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster. </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the instances in the restored DB cluster accept connections. Default: <code>3306</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Constraints: - Must be in the format <code>hh24:mi-hh24:mi</code>. - Times should be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. </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="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. </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="False" position="Named"> <name>S3BucketName</name> <description> <para>The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster. </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="False" position="Named"> <name>S3IngestionRoleArn</name> <description> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf. </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="False" position="Named"> <name>S3Prefix</name> <description> <para>The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a <b>SourceS3Prefix</b> value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket. </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="False" position="Named"> <name>SourceEngine</name> <description> <para>The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: <code>mysql</code> </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="False" position="Named"> <name>SourceEngineVersion</name> <description> <para>The version of the database that the backup files were created from. MySQL version 5.5 and 5.6 are supported. Example: <code>5.6.22</code> </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="False" position="Named"> <name>StorageEncrypted</name> <description> <para>Specifies whether the restored DB cluster is encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of EC2 VPC security groups to associate with the restored DB cluster. </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.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBCluster object. The service call response (type Amazon.RDS.Model.RestoreDBClusterFromS3Response) 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=Restore-RDSDBClusterFromS3.html&tocid=Restore-RDSDBClusterFromS3</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Restore-RDSDBClusterFromSnapshot</name> <description> <para>Invokes the RestoreDBClusterFromSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>Restore</verb> <noun>RDSDBClusterFromSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Restore-RDSDBClusterFromSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-snapshot-id</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DatabaseName</name> <description> <para>The database name for the restored DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EngineVersion</name> <description> <para>The version of the database engine to use for the new DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following will occur: - If the DB snapshot or DB cluster snapshot in <code>SnapshotIdentifier</code> is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. - If the DB snapshot or DB cluster snapshot in <code>SnapshotIdentifier</code> is not encrypted, then the restored DB cluster is not encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>The name of the option group to use for the restored DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the new DB cluster accepts connections. Constraints: Value must be <code>1150-65535</code> Default: The same port as the original DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: - Must match the identifier of an existing Snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>The tags to be assigned to the restored DB cluster. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of VPC security groups that the new DB cluster will belong to. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in. </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="False" position="Named"> <name>DatabaseName</name> <description> <para>The database name for the restored DB cluster. </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 (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: - Must contain from 1 to 255 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-snapshot-id</code> </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>DBSubnetGroupName</name> <description> <para>The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source </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>EngineVersion</name> <description> <para>The version of the database engine to use for the new DB cluster. </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="False" 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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following will occur: - If the DB snapshot or DB cluster snapshot in <code>SnapshotIdentifier</code> is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. - If the DB snapshot or DB cluster snapshot in <code>SnapshotIdentifier</code> is not encrypted, then the restored DB cluster is not encrypted. </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>OptionGroupName</name> <description> <para>The name of the option group to use for the restored DB cluster. </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the new DB cluster accepts connections. Constraints: Value must be <code>1150-65535</code> Default: The same port as the original DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: - Must match the identifier of an existing Snapshot. </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="False" position="Named"> <name>Tag</name> <description> <para>The tags to be assigned to the restored DB cluster. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of VPC security groups that the new DB cluster will belong to. </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.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBCluster object. The service call response (type Amazon.RDS.Model.RestoreDBClusterFromSnapshotResponse) 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=Restore-RDSDBClusterFromSnapshot.html&tocid=Restore-RDSDBClusterFromSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Restore-RDSDBClusterToPointInTime</name> <description> <para>Invokes the RestoreDBClusterToPointInTime operation against Amazon Relational Database Service.</para> </description> <verb>Restore</verb> <noun>RDSDBClusterToPointInTime</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <a>CreateDBInstance</a> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB cluster is available. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Restore-RDSDBClusterToPointInTime</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the new DB cluster to be created. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the <code>KmsKeyId</code> parameter. If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following will occur: - If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. - If the DB cluster is not encrypted, then the restored DB cluster is not encrypted. If <code>DBClusterIdentifier</code> refers to a DB cluster that is not encrypted, then the restore request is rejected. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>The name of the option group for the new DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the new DB cluster accepts connections. Constraints: Value must be <code>1150-65535</code> Default: The same port as the original DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RestoreToTime</name> <description> <para>The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: - Must be before the latest restorable time for the DB instance - Must be specified if <code>UseLatestRestorableTime</code> parameter is not provided - Cannot be specified if <code>UseLatestRestorableTime</code> parameter is true - Cannot be specified if <code>RestoreType</code> parameter is <code>copy-on-write</code> Example: <code>2015-03-07T23:45:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RestoreType</name> <description> <para>The type of restore to be performed. You can specify one of the following values: - <code>full-copy</code> - The new DB cluster is restored as a full copy of the source DB cluster. - <code>copy-on-write</code> - The new DB cluster is restored as a clone of the source DB cluster. Constraints: You cannot specify <code>copy-on-write</code> if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a <code>RestoreType</code> value, then the new DB cluster is restored as a full copy of the source DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceDBClusterIdentifier</name> <description> <para>The identifier of the source DB cluster from which to restore. Constraints: - Must match the identifier of an existing DBCluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseLatestRestorableTime</name> <description> <para>A value that is set to <code>true</code> to restore the DB cluster to the latest restorable backup time, and <code>false</code> otherwise. Default: <code>false</code> Constraints: Cannot be specified if <code>RestoreToTime</code> parameter is provided. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of VPC security groups that the new DB cluster belongs to. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DBClusterIdentifier</name> <description> <para>The name of the new DB cluster to be created. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </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>DBSubnetGroupName</name> <description> <para>The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>KmsKeyId</name> <description> <para>The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the <code>KmsKeyId</code> parameter. If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following will occur: - If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. - If the DB cluster is not encrypted, then the restored DB cluster is not encrypted. If <code>DBClusterIdentifier</code> refers to a DB cluster that is not encrypted, then the restore request is rejected. </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>OptionGroupName</name> <description> <para>The name of the option group for the new DB cluster. </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the new DB cluster accepts connections. Constraints: Value must be <code>1150-65535</code> Default: The same port as the original DB cluster. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RestoreToTime</name> <description> <para>The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: - Must be before the latest restorable time for the DB instance - Must be specified if <code>UseLatestRestorableTime</code> parameter is not provided - Cannot be specified if <code>UseLatestRestorableTime</code> parameter is true - Cannot be specified if <code>RestoreType</code> parameter is <code>copy-on-write</code> Example: <code>2015-03-07T23:45:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RestoreType</name> <description> <para>The type of restore to be performed. You can specify one of the following values: - <code>full-copy</code> - The new DB cluster is restored as a full copy of the source DB cluster. - <code>copy-on-write</code> - The new DB cluster is restored as a clone of the source DB cluster. Constraints: You cannot specify <code>copy-on-write</code> if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a <code>RestoreType</code> value, then the new DB cluster is restored as a full copy of the source DB cluster. </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="False" position="Named"> <name>SourceDBClusterIdentifier</name> <description> <para>The identifier of the source DB cluster from which to restore. Constraints: - Must match the identifier of an existing DBCluster. </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseLatestRestorableTime</name> <description> <para>A value that is set to <code>true</code> to restore the DB cluster to the latest restorable backup time, and <code>false</code> otherwise. Default: <code>false</code> Constraints: Cannot be specified if <code>RestoreToTime</code> parameter is provided. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcSecurityGroupId</name> <description> <para>A list of VPC security groups that the new DB cluster belongs to. </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.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBCluster object. The service call response (type Amazon.RDS.Model.RestoreDBClusterToPointInTimeResponse) 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=Restore-RDSDBClusterToPointInTime.html&tocid=Restore-RDSDBClusterToPointInTime</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Restore-RDSDBInstanceFromDBSnapshot</name> <description> <para>Invokes the RestoreDBInstanceFromDBSnapshot operation against Amazon Relational Database Service.</para> </description> <verb>Restore</verb> <noun>RDSDBInstanceFromDBSnapshot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code> must be the ARN of the shared DB snapshot. </para> </description> <syntax> <syntaxItem> <name>Restore-RDSDBInstanceFromDBSnapshot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: - Must contain from 1 to 63 numbers, letters, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-snapshot-id</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot to restore from. Constraints: - Must match the identifier of an existing DBSnapshot. - If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code> must be the ARN of the shared DB snapshot. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para>Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>. Example: <code>us-east-1a</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The compute and memory capacity of the Amazon RDS DB instance. Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBName</name> <description> <para>The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Domain</name> <description> <para>Specify the Active Directory Domain to restore the instance in. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DomainIAMRoleName</name> <description> <para>Specify the name of the IAM role to be used when making API calls to the Directory Service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher - Aurora 5.6 or higher. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: - <code>aurora</code> - <code>mariadb</code> - <code>mysql</code> - <code>oracle-ee</code> - <code>oracle-se2</code> - <code>oracle-se1</code> - <code>oracle-se</code> - <code>postgres</code> - <code>sqlserver-ee</code> - <code>sqlserver-se</code> - <code>sqlserver-ex</code> - <code>sqlserver-web</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Iops</name> <description> <para>Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts. Constraints: Must be an integer greater than 1000. <b>SQL Server</b> Setting the IOPS value for the SQL Server database engine is not supported. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>License model information for the restored DB instance. Default: Same as source. Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MultiAZ</name> <description> <para>Specifies if the DB instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be <code>1150-65535</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. - <b>Default VPC:</b> true - <b>VPC:</b> false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the DB instance. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialArn</name> <description> <para>The ARN from the Key Store with which to associate the instance for TDE encryption. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialPassword</name> <description> <para>The password for the given ARN from the Key Store in order to access the device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para>Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>. Example: <code>us-east-1a</code> </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="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The compute and memory capacity of the Amazon RDS DB instance. Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> </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 (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para>Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: - Must contain from 1 to 63 numbers, letters, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens Example: <code>my-snapshot-id</code> </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="False" position="Named"> <name>DBName</name> <description> <para>The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. </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="2"> <name>DBSnapshotIdentifier</name> <description> <para>The identifier for the DB snapshot to restore from. Constraints: - Must match the identifier of an existing DBSnapshot. - If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code> must be the ARN of the shared DB snapshot. </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>DBSubnetGroupName</name> <description> <para>The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </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="False" position="Named"> <name>Domain</name> <description> <para>Specify the Active Directory Domain to restore the instance in. </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="False" position="Named"> <name>DomainIAMRoleName</name> <description> <para>Specify the name of the IAM role to be used when making API calls to the Directory Service. </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher - Aurora 5.6 or higher. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: - <code>aurora</code> - <code>mariadb</code> - <code>mysql</code> - <code>oracle-ee</code> - <code>oracle-se2</code> - <code>oracle-se1</code> - <code>oracle-se</code> - <code>postgres</code> - <code>sqlserver-ee</code> - <code>sqlserver-se</code> - <code>sqlserver-ex</code> - <code>sqlserver-web</code> </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="False" 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="False" position="Named"> <name>Iops</name> <description> <para>Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts. Constraints: Must be an integer greater than 1000. <b>SQL Server</b> Setting the IOPS value for the SQL Server database engine is not supported. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>License model information for the restored DB instance. Default: Same as source. Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </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="False" position="Named"> <name>MultiAZ</name> <description> <para>Specifies if the DB instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be <code>1150-65535</code> </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. - <b>Default VPC:</b> true - <b>VPC:</b> false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the DB instance. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialArn</name> <description> <para>The ARN from the Key Store with which to associate the instance for TDE encryption. </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="False" position="Named"> <name>TdeCredentialPassword</name> <description> <para>The password for the given ARN from the Key Store in order to access the device. </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.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotResponse) 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=Restore-RDSDBInstanceFromDBSnapshot.html&tocid=Restore-RDSDBInstanceFromDBSnapshot</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Restore-RDSDBInstanceToPointInTime</name> <description> <para>Invokes the RestoreDBInstanceToPointInTime operation against Amazon Relational Database Service.</para> </description> <verb>Restore</verb> <noun>RDSDBInstanceToPointInTime</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. </para> </description> <syntax> <syntaxItem> <name>Restore-RDSDBInstanceToPointInTime</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceDBInstanceIdentifier</name> <description> <para>The identifier of the source DB instance from which to restore. Constraints: - Must match the identifier of an existing DBInstance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetDBInstanceIdentifier</name> <description> <para>The name of the new database instance to be created. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para>Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: <code>us-east-1a</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The compute and memory capacity of the Amazon RDS DB instance. Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> Default: The same DBInstanceClass as the original DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBName</name> <description> <para>The database name for the restored DB instance. This parameter is not used for the MySQL or MariaDB engines. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSubnetGroupName</name> <description> <para>The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Domain</name> <description> <para>Specify the Active Directory Domain to restore the instance in. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DomainIAMRoleName</name> <description> <para>Specify the name of the IAM role to be used when making API calls to the Directory Service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher - Aurora 5.6 or higher. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: - <code>aurora</code> - <code>mariadb</code> - <code>mysql</code> - <code>oracle-ee</code> - <code>oracle-se2</code> - <code>oracle-se1</code> - <code>oracle-se</code> - <code>postgres</code> - <code>sqlserver-ee</code> - <code>sqlserver-se</code> - <code>sqlserver-ex</code> - <code>sqlserver-web</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Iops</name> <description> <para>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be an integer greater than 1000. <b>SQL Server</b> Setting the IOPS value for the SQL Server database engine is not supported. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>License model information for the restored DB instance. Default: Same as source. Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MultiAZ</name> <description> <para>Specifies if the DB instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Port</name> <description> <para>The port number on which the database accepts connections. Constraints: Value must be <code>1150-65535</code> Default: The same port as the original DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. - <b>Default VPC:</b>true - <b>VPC:</b>false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RestoreTime</name> <description> <para>The date and time to restore from. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: - Must be before the latest restorable time for the DB instance - Cannot be specified if UseLatestRestorableTime parameter is true Example: <code>2009-09-07T23:45:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the DB instance. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialArn</name> <description> <para>The ARN from the Key Store with which to associate the instance for TDE encryption. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TdeCredentialPassword</name> <description> <para>The password for the given ARN from the Key Store in order to access the device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseLatestRestorableTime</name> <description> <para> Specifies whether (<code>true</code>) or not (<code>false</code>) the DB instance is restored from the latest backup time. Default: <code>false</code> Constraints: Cannot be specified if RestoreTime parameter is provided. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoMinorVersionUpgrade</name> <description> <para>Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: <code>us-east-1a</code> </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="False" position="Named"> <name>CopyTagsToSnapshot</name> <description> <para>True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBInstanceClass</name> <description> <para>The compute and memory capacity of the Amazon RDS DB instance. Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code> Default: The same DBInstanceClass as the original DB instance. </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="False" position="Named"> <name>DBName</name> <description> <para>The database name for the restored DB instance. This parameter is not used for the MySQL or MariaDB engines. </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>DBSubnetGroupName</name> <description> <para>The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: <code>mySubnetgroup</code> </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="False" position="Named"> <name>Domain</name> <description> <para>Specify the Active Directory Domain to restore the instance in. </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="False" position="Named"> <name>DomainIAMRoleName</name> <description> <para>Specify the name of the IAM role to be used when making API calls to the Directory Service. </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="False" position="Named"> <name>EnableIAMDatabaseAuthentication</name> <description> <para>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false. You can enable IAM database authentication for the following database engines - For MySQL 5.6, minor version 5.6.34 or higher - For MySQL 5.7, minor version 5.7.16 or higher - Aurora 5.6 or higher. Default: <code>false</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Engine</name> <description> <para>The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: - <code>aurora</code> - <code>mariadb</code> - <code>mysql</code> - <code>oracle-ee</code> - <code>oracle-se2</code> - <code>oracle-se1</code> - <code>oracle-se</code> - <code>postgres</code> - <code>sqlserver-ee</code> - <code>sqlserver-se</code> - <code>sqlserver-ex</code> - <code>sqlserver-web</code> </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="False" 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="False" position="Named"> <name>Iops</name> <description> <para>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be an integer greater than 1000. <b>SQL Server</b> Setting the IOPS value for the SQL Server database engine is not supported. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LicenseModel</name> <description> <para>License model information for the restored DB instance. Default: Same as source. Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </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="False" position="Named"> <name>MultiAZ</name> <description> <para>Specifies if the DB instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>OptionGroupName</name> <description> <para>The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </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="False" position="Named"> <name>Port</name> <description> <para>The port number on which the database accepts connections. Constraints: Value must be <code>1150-65535</code> Default: The same port as the original DB instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PubliclyAccessible</name> <description> <para>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. - <b>Default VPC:</b>true - <b>VPC:</b>false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RestoreTime</name> <description> <para>The date and time to restore from. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: - Must be before the latest restorable time for the DB instance - Cannot be specified if UseLatestRestorableTime parameter is true Example: <code>2009-09-07T23:45:00Z</code> </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceDBInstanceIdentifier</name> <description> <para>The identifier of the source DB instance from which to restore. Constraints: - Must match the identifier of an existing DBInstance. </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="False" position="Named"> <name>StorageType</name> <description> <para>Specifies the storage type to be associated with the DB instance. Valid values: <code>standard | gp2 | io1</code> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code> </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="False" position="Named"> <name>Tag</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.RDS.Model.Tag[]</parameterValue> <type> <name>Amazon.RDS.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>TargetDBInstanceIdentifier</name> <description> <para>The name of the new database instance to be created. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens - First character must be a letter - Cannot end with a hyphen or contain two consecutive hyphens </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="False" position="Named"> <name>TdeCredentialArn</name> <description> <para>The ARN from the Key Store with which to associate the instance for TDE encryption. </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="False" position="Named"> <name>TdeCredentialPassword</name> <description> <para>The password for the given ARN from the Key Store in order to access the device. </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="False" position="Named"> <name>UseLatestRestorableTime</name> <description> <para> Specifies whether (<code>true</code>) or not (<code>false</code>) the DB instance is restored from the latest backup time. Default: <code>false</code> Constraints: Cannot be specified if RestoreTime parameter is provided. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.RestoreDBInstanceToPointInTimeResponse) 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=Restore-RDSDBInstanceToPointInTime.html&tocid=Restore-RDSDBInstanceToPointInTime</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Revoke-RDSDBSecurityGroupIngress</name> <description> <para>Invokes the RevokeDBSecurityGroupIngress operation against Amazon Relational Database Service.</para> </description> <verb>Revoke</verb> <noun>RDSDBSecurityGroupIngress</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). </para> </description> <syntax> <syntaxItem> <name>Revoke-RDSDBSecurityGroupIngress</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name of the DB security group to revoke ingress from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>CIDRIP</name> <description> <para> The IP range to revoke access from. Must be a valid CIDR range. If <code>CIDRIP</code> is specified, <code>EC2SecurityGroupName</code>, <code>EC2SecurityGroupId</code> and <code>EC2SecurityGroupOwnerId</code> cannot be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EC2SecurityGroupId</name> <description> <para> The id of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EC2SecurityGroupName</name> <description> <para> The name of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EC2SecurityGroupOwnerId</name> <description> <para> The AWS Account Number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>CIDRIP</name> <description> <para> The IP range to revoke access from. Must be a valid CIDR range. If <code>CIDRIP</code> is specified, <code>EC2SecurityGroupName</code>, <code>EC2SecurityGroupId</code> and <code>EC2SecurityGroupOwnerId</code> cannot be provided. </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 (ByValue, ByPropertyName)" position="1"> <name>DBSecurityGroupName</name> <description> <para>The name of the DB security group to revoke ingress from. </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>EC2SecurityGroupId</name> <description> <para> The id of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </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>EC2SecurityGroupName</name> <description> <para> The name of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </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>EC2SecurityGroupOwnerId</name> <description> <para> The AWS Account Number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBSecurityGroup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBSecurityGroup object. The service call response (type Amazon.RDS.Model.RevokeDBSecurityGroupIngressResponse) 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=Revoke-RDSDBSecurityGroupIngress.html&tocid=Revoke-RDSDBSecurityGroupIngress</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Start-RDSDBClusterFailover</name> <description> <para>Invokes the FailoverDBCluster operation against Amazon Relational Database Service.</para> </description> <verb>Start</verb> <noun>RDSDBClusterFailover</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </description> <syntax> <syntaxItem> <name>Start-RDSDBClusterFailover</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>A DB cluster identifier to force a failover for. This parameter is not case-sensitive. Constraints: - Must match the identifier of an existing DBCluster. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetDBInstanceIdentifier</name> <description> <para>The name of the instance to promote to the primary instance. You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, <code>mydbcluster-replica1</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DBClusterIdentifier</name> <description> <para>A DB cluster identifier to force a failover for. This parameter is not case-sensitive. Constraints: - Must match the identifier of an existing DBCluster. </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="False" 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="False" position="Named"> <name>TargetDBInstanceIdentifier</name> <description> <para>The name of the instance to promote to the primary instance. You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, <code>mydbcluster-replica1</code>. </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.RDS.Model.DBCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBCluster object. The service call response (type Amazon.RDS.Model.FailoverDBClusterResponse) 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=Start-RDSDBClusterFailover.html&tocid=Start-RDSDBClusterFailover</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Start-RDSDBInstance</name> <description> <para>Invokes the StartDBInstance operation against Amazon Relational Database Service.</para> </description> <verb>Start</verb> <noun>RDSDBInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide. </para> </description> <syntax> <syntaxItem> <name>Start-RDSDBInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para> The user-supplied instance identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para> The user-supplied instance identifier. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.StartDBInstanceResponse) 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=Start-RDSDBInstance.html&tocid=Start-RDSDBInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Stop-RDSDBInstance</name> <description> <para>Invokes the StopDBInstance operation against Amazon Relational Database Service.</para> </description> <verb>Stop</verb> <noun>RDSDBInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Stops a DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide. </para> </description> <syntax> <syntaxItem> <name>Stop-RDSDBInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para> The user-supplied instance identifier. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>DBSnapshotIdentifier</name> <description> <para> The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DBInstanceIdentifier</name> <description> <para> The user-supplied instance identifier. </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>DBSnapshotIdentifier</name> <description> <para> The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.RDS.Model.DBInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a DBInstance object. The service call response (type Amazon.RDS.Model.StopDBInstanceResponse) 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=Stop-RDSDBInstance.html&tocid=Stop-RDSDBInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Submit-RDSPendingMaintenanceAction</name> <description> <para>Invokes the ApplyPendingMaintenanceAction operation against Amazon Relational Database Service.</para> </description> <verb>Submit</verb> <noun>RDSPendingMaintenanceAction</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Applies a pending maintenance action to a resource (for example, to a DB instance). </para> </description> <syntax> <syntaxItem> <name>Submit-RDSPendingMaintenanceAction</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceIdentifier</name> <description> <para>The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApplyAction</name> <description> <para>The pending maintenance action to apply to this resource. Valid values: <code>system-update</code>, <code>db-upgrade</code> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OptInType</name> <description> <para>A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type <code>immediate</code> cannot be undone. Valid values: - <code>immediate</code> - Apply the maintenance action immediately. - <code>next-maintenance</code> - Apply the maintenance action during the next maintenance window for the resource. - <code>undo-opt-in</code> - Cancel any existing <code>next-maintenance</code> opt-in requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ApplyAction</name> <description> <para>The pending maintenance action to apply to this resource. Valid values: <code>system-update</code>, <code>db-upgrade</code> </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="False" 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="False" position="Named"> <name>OptInType</name> <description> <para>A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type <code>immediate</code> cannot be undone. Valid values: - <code>immediate</code> - Apply the maintenance action immediately. - <code>next-maintenance</code> - Apply the maintenance action during the next maintenance window for the resource. - <code>undo-opt-in</code> - Cancel any existing <code>next-maintenance</code> opt-in requests. </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 (ByValue, )" position="1"> <name>ResourceIdentifier</name> <description> <para>The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing"> Constructing an RDS Amazon Resource Name (ARN)</a>. </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.RDS.Model.ResourcePendingMaintenanceActions</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ResourcePendingMaintenanceActions object. The service call response (type Amazon.RDS.Model.ApplyPendingMaintenanceActionResponse) 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=Submit-RDSPendingMaintenanceAction.html&tocid=Submit-RDSPendingMaintenanceAction</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/</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>Get-POLLexicon</name> <description> <para>Invokes the GetLexicon operation against Amazon Polly.</para> </description> <verb>Get</verb> <noun>POLLexicon</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>. </para> </description> <syntax> <syntaxItem> <name>Get-POLLexicon</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>Name of the lexicon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>Name of the lexicon. </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.Polly.Model.GetLexiconResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Polly.Model.GetLexiconResponse 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-POLLexicon.html&tocid=Get-POLLexicon</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>Get-POLLexiconList</name> <description> <para>Invokes the ListLexicons operation against Amazon Polly.</para> </description> <verb>Get</verb> <noun>POLLexiconList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>. </para> </description> <syntax> <syntaxItem> <name>Get-POLLexiconList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>NextToken</name> <description> <para>An opaque pagination token returned from previous <code>ListLexicons</code> operation. If present, indicates where to continue the list of lexicons. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>NextToken</name> <description> <para>An opaque pagination token returned from previous <code>ListLexicons</code> operation. If present, indicates where to continue the list of lexicons. </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.Polly.Model.LexiconDescription</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of LexiconDescription objects. The service call response (type Amazon.Polly.Model.ListLexiconsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-POLLexiconList.html&tocid=Get-POLLexiconList</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>Get-POLSpeech</name> <description> <para>Invokes the SynthesizeSpeech operation against Amazon Polly.</para> </description> <verb>Get</verb> <noun>POLSpeech</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.html">How it Works</a>. </para> </description> <syntax> <syntaxItem> <name>Get-POLSpeech</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Text</name> <description> <para> Input text to synthesize. If you specify <code>ssml</code> as the <code>TextType</code>, follow the SSML format for the input text. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LexiconName</name> <description> <para>List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see <a href="http://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html">PutLexicon</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputFormat</name> <description> <para> The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Polly.OutputFormat</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SampleRate</name> <description> <para> The audio frequency specified in Hz. The valid values for <code>mp3</code> and <code>ogg_vorbis</code> are "8000", "16000", and "22050". The default value is "22050". Valid values for <code>pcm</code> are "8000" and "16000" The default value is "16000". </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SpeechMarkType</name> <description> <para>The type of speech marks returned for the input text. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TextType</name> <description> <para> Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/ssml.html">Using SSML</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Polly.TextType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceId</name> <description> <para> Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the <a href="http://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Polly.VoiceId</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LexiconName</name> <description> <para>List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see <a href="http://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html">PutLexicon</a>. </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="False" position="Named"> <name>OutputFormat</name> <description> <para> The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Polly.OutputFormat</parameterValue> <type> <name>Amazon.Polly.OutputFormat</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SampleRate</name> <description> <para> The audio frequency specified in Hz. The valid values for <code>mp3</code> and <code>ogg_vorbis</code> are "8000", "16000", and "22050". The default value is "22050". Valid values for <code>pcm</code> are "8000" and "16000" The default value is "16000". </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="False" position="Named"> <name>SpeechMarkType</name> <description> <para>The type of speech marks returned for the input text. </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 (ByValue, )" position="1"> <name>Text</name> <description> <para> Input text to synthesize. If you specify <code>ssml</code> as the <code>TextType</code>, follow the SSML format for the input text. </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="False" position="Named"> <name>TextType</name> <description> <para> Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/ssml.html">Using SSML</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Polly.TextType</parameterValue> <type> <name>Amazon.Polly.TextType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VoiceId</name> <description> <para> Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the <a href="http://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html">DescribeVoices</a> operation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Polly.VoiceId</parameterValue> <type> <name>Amazon.Polly.VoiceId</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Polly.Model.SynthesizeSpeechResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.Polly.Model.SynthesizeSpeechResponse 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-POLSpeech.html&tocid=Get-POLSpeech</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>Get-POLVoice</name> <description> <para>Invokes the DescribeVoices operation against Amazon Polly.</para> </description> <verb>Get</verb> <noun>POLVoice</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name. When synthesizing speech ( <code>SynthesizeSpeech</code> ), you provide the voice ID for the voice you want from the list of voices returned by <code>DescribeVoices</code>. For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the <code>DescribeVoices</code> operation you can provide the user with a list of available voices to select from. You can optionally specify a language code to filter the available voices. For example, if you specify <code>en-US</code>, the operation returns a list of all available US English voices. This operation requires permissions to perform the <code>polly:DescribeVoices</code> action. </para> </description> <syntax> <syntaxItem> <name>Get-POLVoice</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>LanguageCode</name> <description> <para> The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Polly.LanguageCode</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>An opaque pagination token returned from the previous <code>DescribeVoices</code> operation. If present, this indicates where to continue the listing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>LanguageCode</name> <description> <para> The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Polly.LanguageCode</parameterValue> <type> <name>Amazon.Polly.LanguageCode</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>An opaque pagination token returned from the previous <code>DescribeVoices</code> operation. If present, this indicates where to continue the listing. </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.Polly.Model.Voice</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Voice objects. The service call response (type Amazon.Polly.Model.DescribeVoicesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-POLVoice.html&tocid=Get-POLVoice</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-POLLexicon</name> <description> <para>Invokes the DeleteLexicon operation against Amazon Polly.</para> </description> <verb>Remove</verb> <noun>POLLexicon</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the <code>GetLexicon</code> or <code>ListLexicon</code> APIs. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-POLLexicon</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the lexicon to delete. Must be an existing lexicon in the region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The name of the lexicon to delete. Must be an existing lexicon in the region. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Name parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Polly.Model.DeleteLexiconResponse) 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-POLLexicon.html&tocid=Remove-POLLexicon</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>Write-POLLexicon</name> <description> <para>Invokes the PutLexicon operation against Amazon Polly.</para> </description> <verb>Write</verb> <noun>POLLexicon</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation. For more information, see <a href="http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html">Managing Lexicons</a>. </para> </description> <syntax> <syntaxItem> <name>Write-POLLexicon</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Content</name> <description> <para>Content of the PLS lexicon as string data. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Content parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Content</name> <description> <para>Content of the PLS lexicon as string data. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Content parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Content parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Polly.Model.PutLexiconResponse) 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=Write-POLLexicon.html&tocid=Write-POLLexicon</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>Get-PINAdmChannel</name> <description> <para>Invokes the GetAdmChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINAdmChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get an ADM channel </para> </description> <syntax> <syntaxItem> <name>Get-PINAdmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.ADMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ADMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetAdmChannelResponse) 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-PINAdmChannel.html&tocid=Get-PINAdmChannel</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>Get-PINApnsChannel</name> <description> <para>Invokes the GetApnsChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINApnsChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the APNs channel for an app. </para> </description> <syntax> <syntaxItem> <name>Get-PINApnsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.APNSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetApnsChannelResponse) 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-PINApnsChannel.html&tocid=Get-PINApnsChannel</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>Get-PINApnsSandboxChannel</name> <description> <para>Invokes the GetApnsSandboxChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINApnsSandboxChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get an APNS sandbox channel </para> </description> <syntax> <syntaxItem> <name>Get-PINApnsSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.APNSSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetApnsSandboxChannelResponse) 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-PINApnsSandboxChannel.html&tocid=Get-PINApnsSandboxChannel</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>Get-PINApnsVoipChannel</name> <description> <para>Invokes the GetApnsVoipChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINApnsVoipChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get an APNS VoIP channel </para> </description> <syntax> <syntaxItem> <name>Get-PINApnsVoipChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.APNSVoipChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSVoipChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetApnsVoipChannelResponse) 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-PINApnsVoipChannel.html&tocid=Get-PINApnsVoipChannel</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>Get-PINApnsVoipSandboxChannel</name> <description> <para>Invokes the GetApnsVoipSandboxChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINApnsVoipSandboxChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get an APNS VoipSandbox channel </para> </description> <syntax> <syntaxItem> <name>Get-PINApnsVoipSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.APNSVoipSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSVoipSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetApnsVoipSandboxChannelResponse) 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-PINApnsVoipSandboxChannel.html&tocid=Get-PINApnsVoipSandboxChannel</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>Get-PINApp</name> <description> <para>Invokes the GetApp operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINApp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about an app. </para> </description> <syntax> <syntaxItem> <name>Get-PINApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.ApplicationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ApplicationResponse object. The service call response (type Amazon.Pinpoint.Model.GetAppResponse) 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-PINApp.html&tocid=Get-PINApp</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>Get-PINApplicationSettingList</name> <description> <para>Invokes the GetApplicationSettings operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINApplicationSettingList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used to request the settings for an app. </para> </description> <syntax> <syntaxItem> <name>Get-PINApplicationSettingList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.ApplicationSettingsResource</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ApplicationSettingsResource object. The service call response (type Amazon.Pinpoint.Model.GetApplicationSettingsResponse) 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-PINApplicationSettingList.html&tocid=Get-PINApplicationSettingList</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>Get-PINAppList</name> <description> <para>Invokes the GetApps operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINAppList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about your apps. </para> </description> <syntax> <syntaxItem> <name>Get-PINAppList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Token</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.ApplicationsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ApplicationsResponse object. The service call response (type Amazon.Pinpoint.Model.GetAppsResponse) 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-PINAppList.html&tocid=Get-PINAppList</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>Get-PINBaiduChannel</name> <description> <para>Invokes the GetBaiduChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINBaiduChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get a BAIDU GCM channel </para> </description> <syntax> <syntaxItem> <name>Get-PINBaiduChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.BaiduChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a BaiduChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetBaiduChannelResponse) 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-PINBaiduChannel.html&tocid=Get-PINBaiduChannel</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>Get-PINCampaign</name> <description> <para>Invokes the GetCampaign operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINCampaign</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about a campaign. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaign</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignResponse) 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-PINCampaign.html&tocid=Get-PINCampaign</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>Get-PINCampaignActivityList</name> <description> <para>Invokes the GetCampaignActivities operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINCampaignActivityList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the activity performed by a campaign. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignActivityList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </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="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </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.Pinpoint.Model.ActivitiesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ActivitiesResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignActivitiesResponse) 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-PINCampaignActivityList.html&tocid=Get-PINCampaignActivityList</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>Get-PINCampaignList</name> <description> <para>Invokes the GetCampaigns operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINCampaignList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about your campaigns. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </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="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </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.Pinpoint.Model.CampaignsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CampaignsResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignsResponse) 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-PINCampaignList.html&tocid=Get-PINCampaignList</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>Get-PINCampaignVersion</name> <description> <para>Invokes the GetCampaignVersion operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINCampaignVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about a specific version of a campaign. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Version</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignVersionResponse) 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-PINCampaignVersion.html&tocid=Get-PINCampaignVersion</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>Get-PINCampaignVersionList</name> <description> <para>Invokes the GetCampaignVersions operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINCampaignVersionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about your campaign versions. </para> </description> <syntax> <syntaxItem> <name>Get-PINCampaignVersionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </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="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </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.Pinpoint.Model.CampaignsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CampaignsResponse object. The service call response (type Amazon.Pinpoint.Model.GetCampaignVersionsResponse) 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-PINCampaignVersionList.html&tocid=Get-PINCampaignVersionList</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>Get-PINEmailChannel</name> <description> <para>Invokes the GetEmailChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINEmailChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get an email channel </para> </description> <syntax> <syntaxItem> <name>Get-PINEmailChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.EmailChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EmailChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetEmailChannelResponse) 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-PINEmailChannel.html&tocid=Get-PINEmailChannel</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>Get-PINEndpoint</name> <description> <para>Invokes the GetEndpoint operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINEndpoint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about an endpoint. </para> </description> <syntax> <syntaxItem> <name>Get-PINEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>EndpointId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.EndpointResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EndpointResponse object. The service call response (type Amazon.Pinpoint.Model.GetEndpointResponse) 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-PINEndpoint.html&tocid=Get-PINEndpoint</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>Get-PINEventStream</name> <description> <para>Invokes the GetEventStream operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINEventStream</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the event stream for an app. </para> </description> <syntax> <syntaxItem> <name>Get-PINEventStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>ApplicationId </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>ApplicationId </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.Pinpoint.Model.EventStream</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventStream object. The service call response (type Amazon.Pinpoint.Model.GetEventStreamResponse) 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-PINEventStream.html&tocid=Get-PINEventStream</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>Get-PINGcmChannel</name> <description> <para>Invokes the GetGcmChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINGcmChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the GCM channel for an app. </para> </description> <syntax> <syntaxItem> <name>Get-PINGcmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.GCMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a GCMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetGcmChannelResponse) 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-PINGcmChannel.html&tocid=Get-PINGcmChannel</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>Get-PINImportJob</name> <description> <para>Invokes the GetImportJob operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINImportJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about an import job. </para> </description> <syntax> <syntaxItem> <name>Get-PINImportJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>JobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>JobId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.ImportJobResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ImportJobResponse object. The service call response (type Amazon.Pinpoint.Model.GetImportJobResponse) 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-PINImportJob.html&tocid=Get-PINImportJob</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>Get-PINImportJobList</name> <description> <para>Invokes the GetImportJobs operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINImportJobList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about your import jobs. </para> </description> <syntax> <syntaxItem> <name>Get-PINImportJobList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </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="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </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.Pinpoint.Model.ImportJobsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ImportJobsResponse object. The service call response (type Amazon.Pinpoint.Model.GetImportJobsResponse) 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-PINImportJobList.html&tocid=Get-PINImportJobList</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>Get-PINSegment</name> <description> <para>Invokes the GetSegment operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINSegment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about a segment. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentResponse) 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-PINSegment.html&tocid=Get-PINSegment</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>Get-PINSegmentImportJobList</name> <description> <para>Invokes the GetSegmentImportJobs operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINSegmentImportJobList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of import jobs for a specific segment. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentImportJobList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </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="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </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.Pinpoint.Model.ImportJobsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ImportJobsResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentImportJobsResponse) 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-PINSegmentImportJobList.html&tocid=Get-PINSegmentImportJobList</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>Get-PINSegmentList</name> <description> <para>Invokes the GetSegments operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINSegmentList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used to get information about your segments. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </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="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </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.Pinpoint.Model.SegmentsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SegmentsResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentsResponse) 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-PINSegmentList.html&tocid=Get-PINSegmentList</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>Get-PINSegmentVersion</name> <description> <para>Invokes the GetSegmentVersion operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINSegmentVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about a segment version. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Version</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Version</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentVersionResponse) 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-PINSegmentVersion.html&tocid=Get-PINSegmentVersion</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>Get-PINSegmentVersionList</name> <description> <para>Invokes the GetSegmentVersions operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINSegmentVersionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about your segment versions. </para> </description> <syntax> <syntaxItem> <name>Get-PINSegmentVersionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PageSize</name> <description> <para>The number of entries you want on each page in the response. </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="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Token</name> <description> <para>The NextToken string returned on a previous page that you use to get the next page of results in a paginated response. </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.Pinpoint.Model.SegmentsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SegmentsResponse object. The service call response (type Amazon.Pinpoint.Model.GetSegmentVersionsResponse) 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-PINSegmentVersionList.html&tocid=Get-PINSegmentVersionList</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>Get-PINSmsChannel</name> <description> <para>Invokes the GetSmsChannel operation against Amazon Pinpoint.</para> </description> <verb>Get</verb> <noun>PINSmsChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Get an SMS channel </para> </description> <syntax> <syntaxItem> <name>Get-PINSmsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.SMSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SMSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.GetSmsChannelResponse) 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-PINSmsChannel.html&tocid=Get-PINSmsChannel</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>New-PINApp</name> <description> <para>Invokes the CreateApp operation against Amazon Pinpoint.</para> </description> <verb>New</verb> <noun>PINApp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates or updates an app. </para> </description> <syntax> <syntaxItem> <name>New-PINApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreateApplicationRequest_Name</name> <description> <para>The display name of the application. Used in the Amazon Pinpoint console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreateApplicationRequest_Name</name> <description> <para>The display name of the application. Used in the Amazon Pinpoint console. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ApplicationResponse object. The service call response (type Amazon.Pinpoint.Model.CreateAppResponse) 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=New-PINApp.html&tocid=New-PINApp</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>New-PINCampaign</name> <description> <para>Invokes the CreateCampaign operation against Amazon Pinpoint.</para> </description> <verb>New</verb> <noun>PINCampaign</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates or updates a campaign. </para> </description> <syntax> <syntaxItem> <name>New-PINCampaign</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_AdditionalTreatment</name> <description> <para>Treatments that are defined in addition to the default treatment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.WriteTreatmentResource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The email text body. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The SMS text body. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that the campaign can send daily. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Description</name> <description> <para>A description of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The default end time for quiet time in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_EndTime</name> <description> <para>The scheduled time that the campaign ends in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>How often the campaign delivers messages.Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Frequency</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_HoldoutPercent</name> <description> <para>The allocated percentage of end users who will not receive messages from this campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_HtmlBody</name> <description> <para>The email html body. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_IsLocalTime</name> <description> <para>Indicates whether the campaign schedule takes effect according to each user's local time. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_IsPaused</name> <description> <para>Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>Is this is a transactional SMS message, otherwise a promotional message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Name</name> <description> <para>The custom name of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentId</name> <description> <para>The ID of the segment to which the campaign sends messages. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentVersion</name> <description> <para>The version of the segment to which the campaign sends messages. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>Sender ID of sent message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The default start time for quiet time in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_StartTime</name> <description> <para>The scheduled time that the campaign begins in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Timezone</name> <description> <para>The starting UTC offset for the schedule if the value for isLocalTime is trueValid values: UTCUTC+01UTC+02UTC+03UTC+03:30UTC+04UTC+04:30UTC+05UTC+05:30UTC+05:45UTC+06UTC+06:30UTC+07UTC+08UTC+09UTC+09:30UTC+10UTC+10:30UTC+11UTC+12UTC+13UTC-02UTC-03UTC-04UTC-05UTC-06UTC-07UTC-08UTC-09UTC-10UTC-11 </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Title</name> <description> <para>The email title (Or subject). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum total number of messages that the campaign can send. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentDescription</name> <description> <para>A custom description for the treatment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentName</name> <description> <para>The custom name of a variation of the campaign used for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>ADMMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>ADMMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>ADMMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>APNSMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>APNSMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>APNSMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>APNSMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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 (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>BaiduMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>BaiduMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>BaiduMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>DefaultMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>DefaultMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>DefaultMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>DefaultMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>DefaultMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>DefaultMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>DefaultMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>DefaultMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>DefaultMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The email text body. </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="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel. </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="False" position="Named"> <name>EmailMessage_HtmlBody</name> <description> <para>The email html body. </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="False" position="Named"> <name>EmailMessage_Title</name> <description> <para>The email title (Or subject). </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="False" 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="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>GCMMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>GCMMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>GCMMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that the campaign can send daily. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum total number of messages that the campaign can send. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The default end time for quiet time in ISO 8601 format. </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="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The default start time for quiet time in ISO 8601 format. </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="False" position="Named"> <name>Schedule_EndTime</name> <description> <para>The scheduled time that the campaign ends in ISO 8601 format. </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="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>How often the campaign delivers messages.Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Frequency</parameterValue> <type> <name>Amazon.Pinpoint.Frequency</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_IsLocalTime</name> <description> <para>Indicates whether the campaign schedule takes effect according to each user's local time. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_StartTime</name> <description> <para>The scheduled time that the campaign begins in ISO 8601 format. </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="False" position="Named"> <name>Schedule_Timezone</name> <description> <para>The starting UTC offset for the schedule if the value for isLocalTime is trueValid values: UTCUTC+01UTC+02UTC+03UTC+03:30UTC+04UTC+04:30UTC+05UTC+05:30UTC+05:45UTC+06UTC+06:30UTC+07UTC+08UTC+09UTC+09:30UTC+10UTC+10:30UTC+11UTC+12UTC+13UTC-02UTC-03UTC-04UTC-05UTC-06UTC-07UTC-08UTC-09UTC-10UTC-11 </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="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The SMS text body. </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="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>Is this is a transactional SMS message, otherwise a promotional message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> <type> <name>Amazon.Pinpoint.MessageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>Sender ID of sent message. </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="False" position="Named"> <name>WriteCampaignRequest_AdditionalTreatment</name> <description> <para>Treatments that are defined in addition to the default treatment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.WriteTreatmentResource[]</parameterValue> <type> <name>Amazon.Pinpoint.Model.WriteTreatmentResource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Description</name> <description> <para>A description of the campaign. </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="False" position="Named"> <name>WriteCampaignRequest_HoldoutPercent</name> <description> <para>The allocated percentage of end users who will not receive messages from this campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_IsPaused</name> <description> <para>Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Name</name> <description> <para>The custom name of the campaign. </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="False" position="Named"> <name>WriteCampaignRequest_SegmentId</name> <description> <para>The ID of the segment to which the campaign sends messages. </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="False" position="Named"> <name>WriteCampaignRequest_SegmentVersion</name> <description> <para>The version of the segment to which the campaign sends messages. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentDescription</name> <description> <para>A custom description for the treatment. </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="False" position="Named"> <name>WriteCampaignRequest_TreatmentName</name> <description> <para>The custom name of a variation of the campaign used for A/B testing. </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.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.CreateCampaignResponse) 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=New-PINCampaign.html&tocid=New-PINCampaign</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>New-PINImportJob</name> <description> <para>Invokes the CreateImportJob operation against Amazon Pinpoint.</para> </description> <verb>New</verb> <noun>PINImportJob</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates or updates an import job. </para> </description> <syntax> <syntaxItem> <name>New-PINImportJob</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_DefineSegment</name> <description> <para>Sets whether the endpoints create a segment when they are imported. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_ExternalId</name> <description> <para>A unique, custom ID assigned to the IAM role that restricts who can assume the role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_Format</name> <description> <para>The format of the files that contain the endpoint definitions.Valid values: CSV, JSON </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Format</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_RegisterEndpoint</name> <description> <para>Sets whether the endpoints are registered with Amazon Pinpoint when they are imported. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_S3Url</name> <description> <para>A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file.The URL should follow this format: s3://bucket-name/folder-name/file-nameAmazon Pinpoint will import endpoints from this location and any subfolders it contains. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_SegmentId</name> <description> <para>The ID of the segment to update if the import job is meant to update an existing segment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_SegmentName</name> <description> <para>A custom name for the segment created by the import job. Use if DefineSegment is true. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>ImportJobRequest_DefineSegment</name> <description> <para>Sets whether the endpoints create a segment when they are imported. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_ExternalId</name> <description> <para>A unique, custom ID assigned to the IAM role that restricts who can assume the role. </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="False" position="Named"> <name>ImportJobRequest_Format</name> <description> <para>The format of the files that contain the endpoint definitions.Valid values: CSV, JSON </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Format</parameterValue> <type> <name>Amazon.Pinpoint.Format</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_RegisterEndpoint</name> <description> <para>Sets whether the endpoints are registered with Amazon Pinpoint when they are imported. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ImportJobRequest_RoleArn</name> <description> <para>The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import. </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="False" position="Named"> <name>ImportJobRequest_S3Url</name> <description> <para>A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file.The URL should follow this format: s3://bucket-name/folder-name/file-nameAmazon Pinpoint will import endpoints from this location and any subfolders it contains. </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="False" position="Named"> <name>ImportJobRequest_SegmentId</name> <description> <para>The ID of the segment to update if the import job is meant to update an existing segment. </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="False" position="Named"> <name>ImportJobRequest_SegmentName</name> <description> <para>A custom name for the segment created by the import job. Use if DefineSegment is true. </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.Pinpoint.Model.ImportJobResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ImportJobResponse object. The service call response (type Amazon.Pinpoint.Model.CreateImportJobResponse) 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=New-PINImportJob.html&tocid=New-PINImportJob</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>New-PINSegment</name> <description> <para>Invokes the CreateSegment operation against Amazon Pinpoint.</para> </description> <verb>New</verb> <noun>PINSegment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used to create or update a segment. </para> </description> <syntax> <syntaxItem> <name>New-PINSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>Custom segment attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_Duration</name> <description> <para>The length of time during which users have been active or inactive with your app.Valid values: HR_24, DAY_7, DAY_14, DAY_30 </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Duration</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Name</name> <description> <para>The name of segment </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_RecencyType</name> <description> <para>The recency dimension type:ACTIVE - Users who have used your app within the specified duration are included in the segment.INACTIVE - Users who have not used your app within the specified duration are included in the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.RecencyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_UserAttribute</name> <description> <para>Custom segment user attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>AppVersion_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Channel_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Country_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>DeviceType_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>Custom segment attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_UserAttribute</name> <description> <para>Custom segment user attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Make_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Model_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Platform_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Recency_Duration</name> <description> <para>The length of time during which users have been active or inactive with your app.Valid values: HR_24, DAY_7, DAY_14, DAY_30 </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Duration</parameterValue> <type> <name>Amazon.Pinpoint.Duration</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_RecencyType</name> <description> <para>The recency dimension type:ACTIVE - Users who have used your app within the specified duration are included in the segment.INACTIVE - Users who have not used your app within the specified duration are included in the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.RecencyType</parameterValue> <type> <name>Amazon.Pinpoint.RecencyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Name</name> <description> <para>The name of segment </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.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.CreateSegmentResponse) 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=New-PINSegment.html&tocid=New-PINSegment</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-PINAdmChannel</name> <description> <para>Invokes the DeleteAdmChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINAdmChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete an ADM channel </para> </description> <syntax> <syntaxItem> <name>Remove-PINAdmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ADMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ADMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteAdmChannelResponse) 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=Remove-PINAdmChannel.html&tocid=Remove-PINAdmChannel</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-PINApnsChannel</name> <description> <para>Invokes the DeleteApnsChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINApnsChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the APNs channel for an app. </para> </description> <syntax> <syntaxItem> <name>Remove-PINApnsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteApnsChannelResponse) 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=Remove-PINApnsChannel.html&tocid=Remove-PINApnsChannel</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-PINApnsSandboxChannel</name> <description> <para>Invokes the DeleteApnsSandboxChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINApnsSandboxChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete an APNS sandbox channel </para> </description> <syntax> <syntaxItem> <name>Remove-PINApnsSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteApnsSandboxChannelResponse) 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=Remove-PINApnsSandboxChannel.html&tocid=Remove-PINApnsSandboxChannel</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-PINApnsVoipChannel</name> <description> <para>Invokes the DeleteApnsVoipChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINApnsVoipChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete an APNS VoIP channel </para> </description> <syntax> <syntaxItem> <name>Remove-PINApnsVoipChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSVoipChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteApnsVoipChannelResponse) 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=Remove-PINApnsVoipChannel.html&tocid=Remove-PINApnsVoipChannel</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-PINApnsVoipSandboxChannel</name> <description> <para>Invokes the DeleteApnsVoipSandboxChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINApnsVoipSandboxChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete an APNS VoIP sandbox channel </para> </description> <syntax> <syntaxItem> <name>Remove-PINApnsVoipSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSVoipSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteApnsVoipSandboxChannelResponse) 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=Remove-PINApnsVoipSandboxChannel.html&tocid=Remove-PINApnsVoipSandboxChannel</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-PINApp</name> <description> <para>Invokes the DeleteApp operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINApp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an app. </para> </description> <syntax> <syntaxItem> <name>Remove-PINApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ApplicationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ApplicationResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteAppResponse) 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=Remove-PINApp.html&tocid=Remove-PINApp</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-PINBaiduChannel</name> <description> <para>Invokes the DeleteBaiduChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINBaiduChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete a BAIDU GCM channel </para> </description> <syntax> <syntaxItem> <name>Remove-PINBaiduChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.BaiduChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a BaiduChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteBaiduChannelResponse) 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=Remove-PINBaiduChannel.html&tocid=Remove-PINBaiduChannel</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-PINCampaign</name> <description> <para>Invokes the DeleteCampaign operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINCampaign</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a campaign. </para> </description> <syntax> <syntaxItem> <name>Remove-PINCampaign</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteCampaignResponse) 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=Remove-PINCampaign.html&tocid=Remove-PINCampaign</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-PINEmailChannel</name> <description> <para>Invokes the DeleteEmailChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINEmailChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete an email channel </para> </description> <syntax> <syntaxItem> <name>Remove-PINEmailChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EmailChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EmailChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteEmailChannelResponse) 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=Remove-PINEmailChannel.html&tocid=Remove-PINEmailChannel</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-PINEventStream</name> <description> <para>Invokes the DeleteEventStream operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINEventStream</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the event stream for an app. </para> </description> <syntax> <syntaxItem> <name>Remove-PINEventStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>ApplicationId </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>ApplicationId </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EventStream</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventStream object. The service call response (type Amazon.Pinpoint.Model.DeleteEventStreamResponse) 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=Remove-PINEventStream.html&tocid=Remove-PINEventStream</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-PINGcmChannel</name> <description> <para>Invokes the DeleteGcmChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINGcmChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the GCM channel for an app. </para> </description> <syntax> <syntaxItem> <name>Remove-PINGcmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.GCMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a GCMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteGcmChannelResponse) 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=Remove-PINGcmChannel.html&tocid=Remove-PINGcmChannel</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-PINSegment</name> <description> <para>Invokes the DeleteSegment operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINSegment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a segment. </para> </description> <syntax> <syntaxItem> <name>Remove-PINSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteSegmentResponse) 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=Remove-PINSegment.html&tocid=Remove-PINSegment</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-PINSmsChannel</name> <description> <para>Invokes the DeleteSmsChannel operation against Amazon Pinpoint.</para> </description> <verb>Remove</verb> <noun>PINSmsChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Delete an SMS channel </para> </description> <syntax> <syntaxItem> <name>Remove-PINSmsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SMSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SMSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.DeleteSmsChannelResponse) 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=Remove-PINSmsChannel.html&tocid=Remove-PINSmsChannel</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-PINMessage</name> <description> <para>Invokes the SendMessages operation against Amazon Pinpoint.</para> </description> <verb>Send</verb> <noun>PINMessage</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Send a batch of messages </para> </description> <syntax> <syntaxItem> <name>Send-PINMessage</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Address</name> <description> <para>A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Badge</name> <description> <para>Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Category</name> <description> <para>Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_CollapseId</name> <description> <para>Multiple notifications with the same collapse identifier are displayed to the user as a single notification. The value of this key must not exceed 64 bytes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_CollapseKey</name> <description> <para>This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ConsolidationKey</name> <description> <para>Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Context</name> <description> <para>A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Endpoint</name> <description> <para>A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ExpiresAfter</name> <description> <para>Optional. Number of seconds ADM should retain the message if the device is offline </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MD5</name> <description> <para>Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL that points to a video used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>Is this a transaction priority message or lower priority. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_PreferredAuthenticationMethod</name> <description> <para>The preferred authentication method, either "CERTIFICATE" or "TOKEN" </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Priority</name> <description> <para>Is this a transaction priority message or lower priority. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Priority</name> <description> <para>Is this a transaction priority message or lower priority. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RestrictedPackageName</name> <description> <para>This parameter specifies the package name of the application where the registration tokens must match in order to receive the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>Sender ID of sent message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Sound</name> <description> <para>Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ThreadId</name> <description> <para>Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>This parameter specifies how long (in seconds) the message should be kept if APNS is unable to deliver the notification the first time. If the value is 0, APNS treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to APNS </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>ADMMessage_ConsolidationKey</name> <description> <para>Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one. </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="False" position="Named"> <name>ADMMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ExpiresAfter</name> <description> <para>Optional. Number of seconds ADM should retain the message if the device is offline </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="False" position="Named"> <name>ADMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </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="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </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="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>ADMMessage_MD5</name> <description> <para>Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity </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="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </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="False" position="Named"> <name>ADMMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </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="False" position="Named"> <name>ADMMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Badge</name> <description> <para>Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>APNSMessage_Category</name> <description> <para>Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories. </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="False" position="Named"> <name>APNSMessage_CollapseId</name> <description> <para>Multiple notifications with the same collapse identifier are displayed to the user as a single notification. The value of this key must not exceed 64 bytes. </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="False" position="Named"> <name>APNSMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL that points to a video used in the push notification. </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="False" position="Named"> <name>APNSMessage_PreferredAuthenticationMethod</name> <description> <para>The preferred authentication method, either "CERTIFICATE" or "TOKEN" </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="False" position="Named"> <name>APNSMessage_Priority</name> <description> <para>Is this a transaction priority message or lower priority. </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="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Sound</name> <description> <para>Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound. </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="False" position="Named"> <name>APNSMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ThreadId</name> <description> <para>Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. </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="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>This parameter specifies how long (in seconds) the message should be kept if APNS is unable to deliver the notification the first time. If the value is 0, APNS treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to APNS </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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 (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>BaiduMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </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="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </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="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </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="False" position="Named"> <name>BaiduMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </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="False" position="Named"> <name>BaiduMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>DefaultMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>DefaultPushNotificationMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>DefaultPushNotificationMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" 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="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>GCMMessage_CollapseKey</name> <description> <para>This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active. </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="False" position="Named"> <name>GCMMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </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="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </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="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>GCMMessage_Priority</name> <description> <para>Is this a transaction priority message or lower priority. </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="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>GCMMessage_RestrictedPackageName</name> <description> <para>This parameter specifies the package name of the application where the registration tokens must match in order to receive the message. </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="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </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="False" position="Named"> <name>GCMMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </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="False" position="Named"> <name>GCMMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>MessageRequest_Address</name> <description> <para>A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Context</name> <description> <para>A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageRequest_Endpoint</name> <description> <para>A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>Is this a transaction priority message or lower priority. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> <type> <name>Amazon.Pinpoint.MessageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>Sender ID of sent message. </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="False" position="Named"> <name>SMSMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a MessageResponse object. The service call response (type Amazon.Pinpoint.Model.SendMessagesResponse) 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=Send-PINMessage.html&tocid=Send-PINMessage</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-PINUserMessageBatch</name> <description> <para>Invokes the SendUsersMessages operation against Amazon Pinpoint.</para> </description> <verb>Send</verb> <noun>PINUserMessageBatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Send a batch of messages to users </para> </description> <syntax> <syntaxItem> <name>Send-PINUserMessageBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Badge</name> <description> <para>Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Category</name> <description> <para>Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_CollapseId</name> <description> <para>Multiple notifications with the same collapse identifier are displayed to the user as a single notification. The value of this key must not exceed 64 bytes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_CollapseKey</name> <description> <para>This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ConsolidationKey</name> <description> <para>Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_Context</name> <description> <para>A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ExpiresAfter</name> <description> <para>Optional. Number of seconds ADM should retain the message if the device is offline </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MD5</name> <description> <para>Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL that points to a video used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>Is this a transaction priority message or lower priority. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_PreferredAuthenticationMethod</name> <description> <para>The preferred authentication method, either "CERTIFICATE" or "TOKEN" </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Priority</name> <description> <para>Is this a transaction priority message or lower priority. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Priority</name> <description> <para>Is this a transaction priority message or lower priority. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RestrictedPackageName</name> <description> <para>This parameter specifies the package name of the application where the registration tokens must match in order to receive the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>Sender ID of sent message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Sound</name> <description> <para>Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ThreadId</name> <description> <para>Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>This parameter specifies how long (in seconds) the message should be kept if APNS is unable to deliver the notification the first time. If the value is 0, APNS treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to APNS </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_User</name> <description> <para>A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>ADMMessage_ConsolidationKey</name> <description> <para>Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one. </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="False" position="Named"> <name>ADMMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ExpiresAfter</name> <description> <para>Optional. Number of seconds ADM should retain the message if the device is offline </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="False" position="Named"> <name>ADMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </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="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </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="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>ADMMessage_MD5</name> <description> <para>Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity </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="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </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="False" position="Named"> <name>ADMMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </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="False" position="Named"> <name>ADMMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Badge</name> <description> <para>Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>APNSMessage_Category</name> <description> <para>Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories. </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="False" position="Named"> <name>APNSMessage_CollapseId</name> <description> <para>Multiple notifications with the same collapse identifier are displayed to the user as a single notification. The value of this key must not exceed 64 bytes. </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="False" position="Named"> <name>APNSMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL that points to a video used in the push notification. </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="False" position="Named"> <name>APNSMessage_PreferredAuthenticationMethod</name> <description> <para>The preferred authentication method, either "CERTIFICATE" or "TOKEN" </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="False" position="Named"> <name>APNSMessage_Priority</name> <description> <para>Is this a transaction priority message or lower priority. </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="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Sound</name> <description> <para>Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound. </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="False" position="Named"> <name>APNSMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ThreadId</name> <description> <para>Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. </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="False" position="Named"> <name>APNSMessage_TimeToLive</name> <description> <para>This parameter specifies how long (in seconds) the message should be kept if APNS is unable to deliver the notification the first time. If the value is 0, APNS treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to APNS </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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 (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>BaiduMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </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="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </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="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </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="False" position="Named"> <name>BaiduMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </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="False" position="Named"> <name>BaiduMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>DefaultMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>DefaultPushNotificationMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultPushNotificationMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>DefaultPushNotificationMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" 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="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>GCMMessage_CollapseKey</name> <description> <para>This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active. </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="False" position="Named"> <name>GCMMessage_Data</name> <description> <para>The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_IconReference</name> <description> <para>The icon image name of the asset saved in your application. </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="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL that points to an image used as the large icon to the notification content view. </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="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>GCMMessage_Priority</name> <description> <para>Is this a transaction priority message or lower priority. </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="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>GCMMessage_RestrictedPackageName</name> <description> <para>This parameter specifies the package name of the application where the registration tokens must match in order to receive the message. </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="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SmallImageIconUrl</name> <description> <para>The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view </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="False" position="Named"> <name>GCMMessage_Sound</name> <description> <para>Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/ </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="False" position="Named"> <name>GCMMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_TimeToLive</name> <description> <para>This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>SendUsersMessageRequest_Context</name> <description> <para>A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendUsersMessageRequest_User</name> <description> <para>A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The message body of the notification, the email body or the text message. </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="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>Is this a transaction priority message or lower priority. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> <type> <name>Amazon.Pinpoint.MessageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>Sender ID of sent message. </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="False" position="Named"> <name>SMSMessage_Substitution</name> <description> <para>Default message substitutions. Can be overridden by individual address substitutions. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.SendUsersMessageResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SendUsersMessageResponse object. The service call response (type Amazon.Pinpoint.Model.SendUsersMessagesResponse) 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=Send-PINUserMessageBatch.html&tocid=Send-PINUserMessageBatch</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>Update-PINAdmChannel</name> <description> <para>Invokes the UpdateAdmChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINAdmChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Update an ADM channel </para> </description> <syntax> <syntaxItem> <name>Update-PINAdmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_ClientId</name> <description> <para>Client ID as gotten from Amazon </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_ClientSecret</name> <description> <para>Client secret as gotten from Amazon </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMChannelRequest_ClientId</name> <description> <para>Client ID as gotten from Amazon </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="False" position="Named"> <name>ADMChannelRequest_ClientSecret</name> <description> <para>Client secret as gotten from Amazon </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="False" position="Named"> <name>ADMChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.ADMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ADMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateAdmChannelResponse) 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=Update-PINAdmChannel.html&tocid=Update-PINAdmChannel</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>Update-PINApnsChannel</name> <description> <para>Invokes the UpdateApnsChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINApnsChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use to update the APNs channel for an app. </para> </description> <syntax> <syntaxItem> <name>Update-PINApnsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_BundleId</name> <description> <para>The bundle id used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_Certificate</name> <description> <para>The distribution certificate from Apple. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method used for APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_PrivateKey</name> <description> <para>The certificate private key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TeamId</name> <description> <para>The team id used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TokenKey</name> <description> <para>The token key used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_TokenKeyId</name> <description> <para>The token key used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_BundleId</name> <description> <para>The bundle id used for APNs Tokens. </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="False" position="Named"> <name>APNSChannelRequest_Certificate</name> <description> <para>The distribution certificate from Apple. </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="False" position="Named"> <name>APNSChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method used for APNs. </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="False" position="Named"> <name>APNSChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSChannelRequest_PrivateKey</name> <description> <para>The certificate private key. </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="False" position="Named"> <name>APNSChannelRequest_TeamId</name> <description> <para>The team id used for APNs Tokens. </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="False" position="Named"> <name>APNSChannelRequest_TokenKey</name> <description> <para>The token key used for APNs Tokens. </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="False" position="Named"> <name>APNSChannelRequest_TokenKeyId</name> <description> <para>The token key used for APNs Tokens. </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 (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateApnsChannelResponse) 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=Update-PINApnsChannel.html&tocid=Update-PINApnsChannel</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>Update-PINApnsSandboxChannel</name> <description> <para>Invokes the UpdateApnsSandboxChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINApnsSandboxChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Update an APNS sandbox channel </para> </description> <syntax> <syntaxItem> <name>Update-PINApnsSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_BundleId</name> <description> <para>The bundle id used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_Certificate</name> <description> <para>The distribution certificate from Apple. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method used for APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_PrivateKey</name> <description> <para>The certificate private key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TeamId</name> <description> <para>The team id used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TokenKey</name> <description> <para>The token key used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_TokenKeyId</name> <description> <para>The token key used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_BundleId</name> <description> <para>The bundle id used for APNs Tokens. </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="False" position="Named"> <name>APNSSandboxChannelRequest_Certificate</name> <description> <para>The distribution certificate from Apple. </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="False" position="Named"> <name>APNSSandboxChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method used for APNs. </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="False" position="Named"> <name>APNSSandboxChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSSandboxChannelRequest_PrivateKey</name> <description> <para>The certificate private key. </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="False" position="Named"> <name>APNSSandboxChannelRequest_TeamId</name> <description> <para>The team id used for APNs Tokens. </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="False" position="Named"> <name>APNSSandboxChannelRequest_TokenKey</name> <description> <para>The token key used for APNs Tokens. </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="False" position="Named"> <name>APNSSandboxChannelRequest_TokenKeyId</name> <description> <para>The token key used for APNs Tokens. </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 (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateApnsSandboxChannelResponse) 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=Update-PINApnsSandboxChannel.html&tocid=Update-PINApnsSandboxChannel</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>Update-PINApnsVoipChannel</name> <description> <para>Invokes the UpdateApnsVoipChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINApnsVoipChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Update an APNS VoIP channel </para> </description> <syntax> <syntaxItem> <name>Update-PINApnsVoipChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_BundleId</name> <description> <para>The bundle id used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_Certificate</name> <description> <para>The distribution certificate from Apple. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method used for APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_PrivateKey</name> <description> <para>The certificate private key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TeamId</name> <description> <para>The team id used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TokenKey</name> <description> <para>The token key used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_TokenKeyId</name> <description> <para>The token key used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_BundleId</name> <description> <para>The bundle id used for APNs Tokens. </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="False" position="Named"> <name>APNSVoipChannelRequest_Certificate</name> <description> <para>The distribution certificate from Apple. </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="False" position="Named"> <name>APNSVoipChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method used for APNs. </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="False" position="Named"> <name>APNSVoipChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipChannelRequest_PrivateKey</name> <description> <para>The certificate private key. </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="False" position="Named"> <name>APNSVoipChannelRequest_TeamId</name> <description> <para>The team id used for APNs Tokens. </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="False" position="Named"> <name>APNSVoipChannelRequest_TokenKey</name> <description> <para>The token key used for APNs Tokens. </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="False" position="Named"> <name>APNSVoipChannelRequest_TokenKeyId</name> <description> <para>The token key used for APNs Tokens. </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 (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSVoipChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateApnsVoipChannelResponse) 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=Update-PINApnsVoipChannel.html&tocid=Update-PINApnsVoipChannel</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>Update-PINApnsVoipSandboxChannel</name> <description> <para>Invokes the UpdateApnsVoipSandboxChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINApnsVoipSandboxChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Update an APNS VoIP sandbox channel </para> </description> <syntax> <syntaxItem> <name>Update-PINApnsVoipSandboxChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_BundleId</name> <description> <para>The bundle id used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_Certificate</name> <description> <para>The distribution certificate from Apple. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method used for APNs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_PrivateKey</name> <description> <para>The certificate private key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TeamId</name> <description> <para>The team id used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TokenKey</name> <description> <para>The token key used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TokenKeyId</name> <description> <para>The token key used for APNs Tokens. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_BundleId</name> <description> <para>The bundle id used for APNs Tokens. </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="False" position="Named"> <name>APNSVoipSandboxChannelRequest_Certificate</name> <description> <para>The distribution certificate from Apple. </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="False" position="Named"> <name>APNSVoipSandboxChannelRequest_DefaultAuthenticationMethod</name> <description> <para>The default authentication method used for APNs. </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="False" position="Named"> <name>APNSVoipSandboxChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSVoipSandboxChannelRequest_PrivateKey</name> <description> <para>The certificate private key. </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="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TeamId</name> <description> <para>The team id used for APNs Tokens. </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="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TokenKey</name> <description> <para>The token key used for APNs Tokens. </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="False" position="Named"> <name>APNSVoipSandboxChannelRequest_TokenKeyId</name> <description> <para>The token key used for APNs Tokens. </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 (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.APNSVoipSandboxChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a APNSVoipSandboxChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateApnsVoipSandboxChannelResponse) 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=Update-PINApnsVoipSandboxChannel.html&tocid=Update-PINApnsVoipSandboxChannel</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>Update-PINApplicationSettingList</name> <description> <para>Invokes the UpdateApplicationSettings operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINApplicationSettingList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Used to update the settings for an app. </para> </description> <syntax> <syntaxItem> <name>Update-PINApplicationSettingList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that the campaign can send daily. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The default end time for quiet time in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The default start time for quiet time in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum total number of messages that the campaign can send. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that the campaign can send daily. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum total number of messages that the campaign can send. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The default end time for quiet time in ISO 8601 format. </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="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The default start time for quiet time in ISO 8601 format. </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.Pinpoint.Model.ApplicationSettingsResource</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a ApplicationSettingsResource object. The service call response (type Amazon.Pinpoint.Model.UpdateApplicationSettingsResponse) 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=Update-PINApplicationSettingList.html&tocid=Update-PINApplicationSettingList</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>Update-PINBaiduChannel</name> <description> <para>Invokes the UpdateBaiduChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINBaiduChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Update a BAIDU GCM channel </para> </description> <syntax> <syntaxItem> <name>Update-PINBaiduChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_ApiKey</name> <description> <para>Platform credential API key from Baidu. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_SecretKey</name> <description> <para>Platform credential Secret key from Baidu. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>BaiduChannelRequest_ApiKey</name> <description> <para>Platform credential API key from Baidu. </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="False" position="Named"> <name>BaiduChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduChannelRequest_SecretKey</name> <description> <para>Platform credential Secret key from Baidu. </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.BaiduChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a BaiduChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateBaiduChannelResponse) 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=Update-PINBaiduChannel.html&tocid=Update-PINBaiduChannel</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>Update-PINCampaign</name> <description> <para>Invokes the UpdateCampaign operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINCampaign</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use to update a campaign. </para> </description> <syntax> <syntaxItem> <name>Update-PINCampaign</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_AdditionalTreatment</name> <description> <para>Treatments that are defined in addition to the default treatment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.WriteTreatmentResource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The email text body. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The SMS text body. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that the campaign can send daily. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Description</name> <description> <para>A description of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The default end time for quiet time in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_EndTime</name> <description> <para>The scheduled time that the campaign ends in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>How often the campaign delivers messages.Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Frequency</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_HoldoutPercent</name> <description> <para>The allocated percentage of end users who will not receive messages from this campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_HtmlBody</name> <description> <para>The email html body. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_IsLocalTime</name> <description> <para>Indicates whether the campaign schedule takes effect according to each user's local time. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_IsPaused</name> <description> <para>Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>Is this is a transactional SMS message, otherwise a promotional message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Name</name> <description> <para>The custom name of the campaign. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentId</name> <description> <para>The ID of the segment to which the campaign sends messages. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_SegmentVersion</name> <description> <para>The version of the segment to which the campaign sends messages. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>Sender ID of sent message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The default start time for quiet time in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_StartTime</name> <description> <para>The scheduled time that the campaign begins in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_Timezone</name> <description> <para>The starting UTC offset for the schedule if the value for isLocalTime is trueValid values: UTCUTC+01UTC+02UTC+03UTC+03:30UTC+04UTC+04:30UTC+05UTC+05:30UTC+05:45UTC+06UTC+06:30UTC+07UTC+08UTC+09UTC+09:30UTC+10UTC+10:30UTC+11UTC+12UTC+13UTC-02UTC-03UTC-04UTC-05UTC-06UTC-07UTC-08UTC-09UTC-10UTC-11 </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailMessage_Title</name> <description> <para>The email title (Or subject). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum total number of messages that the campaign can send. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentDescription</name> <description> <para>A custom description for the treatment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentName</name> <description> <para>The custom name of a variation of the campaign used for A/B testing. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>ADMMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>ADMMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>ADMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>ADMMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>ADMMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>ADMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>ADMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ADMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>ADMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>APNSMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>APNSMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>APNSMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>APNSMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>APNSMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>APNSMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>APNSMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>APNSMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>APNSMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>APNSMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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 (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>BaiduMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>BaiduMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>BaiduMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>BaiduMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>BaiduMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>BaiduMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>BaiduMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>BaiduMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BaiduMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>BaiduMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>CampaignId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>DefaultMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>DefaultMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>DefaultMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>DefaultMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>DefaultMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>DefaultMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>DefaultMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>DefaultMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>DefaultMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>EmailMessage_Body</name> <description> <para>The email text body. </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="False" position="Named"> <name>EmailMessage_FromAddress</name> <description> <para>The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel. </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="False" position="Named"> <name>EmailMessage_HtmlBody</name> <description> <para>The email html body. </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="False" position="Named"> <name>EmailMessage_Title</name> <description> <para>The email title (Or subject). </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="False" 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="False" position="Named"> <name>GCMMessage_Action</name> <description> <para>The action that occurs if the user taps a push notification delivered by the campaign:OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Action</parameterValue> <type> <name>Amazon.Pinpoint.Action</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Body</name> <description> <para>The message body. Can include up to 140 characters. </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="False" position="Named"> <name>GCMMessage_ImageIconUrl</name> <description> <para>The URL that points to the icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>GCMMessage_ImageSmallIconUrl</name> <description> <para>The URL that points to the small icon image for the push notification icon, for example, the app icon. </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="False" position="Named"> <name>GCMMessage_ImageUrl</name> <description> <para>The URL that points to an image used in the push notification. </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="False" position="Named"> <name>GCMMessage_JsonBody</name> <description> <para>The JSON payload used for a silent push. </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="False" position="Named"> <name>GCMMessage_MediaUrl</name> <description> <para>The URL that points to the media resource, for example a .mp4 or .gif file. </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="False" position="Named"> <name>GCMMessage_RawContent</name> <description> <para>The Raw JSON formatted string to be used as the payload. This value overrides the message. </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="False" position="Named"> <name>GCMMessage_SilentPush</name> <description> <para>Indicates if the message should display on the users device.Silent pushes can be used for Remote Configuration and Phone Home use cases. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMMessage_Title</name> <description> <para>The message title that displays above the message on the user's device. </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="False" position="Named"> <name>GCMMessage_Url</name> <description> <para>The URL to open in the user's mobile browser. Used if the value for Action is URL. </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="False" position="Named"> <name>Limits_Daily</name> <description> <para>The maximum number of messages that the campaign can send daily. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MaximumDuration</name> <description> <para>The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_MessagesPerSecond</name> <description> <para>The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50 </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limits_Total</name> <description> <para>The maximum total number of messages that the campaign can send. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuietTime_End</name> <description> <para>The default end time for quiet time in ISO 8601 format. </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="False" position="Named"> <name>QuietTime_Start</name> <description> <para>The default start time for quiet time in ISO 8601 format. </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="False" position="Named"> <name>Schedule_EndTime</name> <description> <para>The scheduled time that the campaign ends in ISO 8601 format. </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="False" position="Named"> <name>Schedule_Frequency</name> <description> <para>How often the campaign delivers messages.Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Frequency</parameterValue> <type> <name>Amazon.Pinpoint.Frequency</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_IsLocalTime</name> <description> <para>Indicates whether the campaign schedule takes effect according to each user's local time. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Schedule_StartTime</name> <description> <para>The scheduled time that the campaign begins in ISO 8601 format. </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="False" position="Named"> <name>Schedule_Timezone</name> <description> <para>The starting UTC offset for the schedule if the value for isLocalTime is trueValid values: UTCUTC+01UTC+02UTC+03UTC+03:30UTC+04UTC+04:30UTC+05UTC+05:30UTC+05:45UTC+06UTC+06:30UTC+07UTC+08UTC+09UTC+09:30UTC+10UTC+10:30UTC+11UTC+12UTC+13UTC-02UTC-03UTC-04UTC-05UTC-06UTC-07UTC-08UTC-09UTC-10UTC-11 </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="False" position="Named"> <name>SMSMessage_Body</name> <description> <para>The SMS text body. </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="False" position="Named"> <name>SMSMessage_MessageType</name> <description> <para>Is this is a transactional SMS message, otherwise a promotional message. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.MessageType</parameterValue> <type> <name>Amazon.Pinpoint.MessageType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSMessage_SenderId</name> <description> <para>Sender ID of sent message. </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="False" position="Named"> <name>WriteCampaignRequest_AdditionalTreatment</name> <description> <para>Treatments that are defined in addition to the default treatment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.WriteTreatmentResource[]</parameterValue> <type> <name>Amazon.Pinpoint.Model.WriteTreatmentResource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Description</name> <description> <para>A description of the campaign. </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="False" position="Named"> <name>WriteCampaignRequest_HoldoutPercent</name> <description> <para>The allocated percentage of end users who will not receive messages from this campaign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_IsPaused</name> <description> <para>Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_Name</name> <description> <para>The custom name of the campaign. </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="False" position="Named"> <name>WriteCampaignRequest_SegmentId</name> <description> <para>The ID of the segment to which the campaign sends messages. </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="False" position="Named"> <name>WriteCampaignRequest_SegmentVersion</name> <description> <para>The version of the segment to which the campaign sends messages. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteCampaignRequest_TreatmentDescription</name> <description> <para>A custom description for the treatment. </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="False" position="Named"> <name>WriteCampaignRequest_TreatmentName</name> <description> <para>The custom name of a variation of the campaign used for A/B testing. </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.Pinpoint.Model.CampaignResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CampaignResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateCampaignResponse) 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=Update-PINCampaign.html&tocid=Update-PINCampaign</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>Update-PINEmailChannel</name> <description> <para>Invokes the UpdateEmailChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINEmailChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Update an email channel </para> </description> <syntax> <syntaxItem> <name>Update-PINEmailChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_FromAddress</name> <description> <para>The email address used to send emails from. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_Identity</name> <description> <para>The ARN of an identity verified with SES. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_RoleArn</name> <description> <para>The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>EmailChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EmailChannelRequest_FromAddress</name> <description> <para>The email address used to send emails from. </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="False" position="Named"> <name>EmailChannelRequest_Identity</name> <description> <para>The ARN of an identity verified with SES. </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="False" position="Named"> <name>EmailChannelRequest_RoleArn</name> <description> <para>The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service </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="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.EmailChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EmailChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateEmailChannelResponse) 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=Update-PINEmailChannel.html&tocid=Update-PINEmailChannel</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>Update-PINEndpoint</name> <description> <para>Invokes the UpdateEndpoint operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINEndpoint</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use to update an endpoint. </para> </description> <syntax> <syntaxItem> <name>Update-PINEndpoint</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Address</name> <description> <para>The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_AppVersion</name> <description> <para>The version of the application associated with the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Attribute</name> <description> <para>Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_ChannelType</name> <description> <para>The channel type.Valid values: GCM | APNS | SMS | EMAIL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.ChannelType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_City</name> <description> <para>The city where the endpoint is located. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Country</name> <description> <para>Country according to ISO 3166-1 Alpha-2 codes. For example, US. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_EffectiveDate</name> <description> <para>The last time the endpoint was updated. Provided in ISO 8601 format. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_EndpointStatus</name> <description> <para>The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Latitude</name> <description> <para>The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile). </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Locale</name> <description> <para>The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Longitude</name> <description> <para>The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile). </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Make</name> <description> <para>The endpoint make, such as such as Apple or Samsung. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_Metric</name> <description> <para>Custom metrics that your app reports to Amazon Pinpoint. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Model</name> <description> <para>The endpoint model, such as iPhone. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_ModelVersion</name> <description> <para>The endpoint model version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_OptOut</name> <description> <para>Indicates whether a user has opted out of receiving messages with one of the following values:ALL - User has opted out of all messages.NONE - Users has not opted out and receives all messages. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Platform</name> <description> <para>The endpoint platform, such as ios or android. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_PlatformVersion</name> <description> <para>The endpoint platform version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_PostalCode</name> <description> <para>The postal code or zip code of the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Region</name> <description> <para>The region of the endpoint location. For example, corresponds to a state in US. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_RequestId</name> <description> <para>The unique ID for the most recent request to update the endpoint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Demographic_Timezone</name> <description> <para>The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>User_UserAttribute</name> <description> <para>Custom attributes specific to the user. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>User_UserId</name> <description> <para>The unique ID of the user. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Demographic_AppVersion</name> <description> <para>The version of the application associated with the endpoint. </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="False" position="Named"> <name>Demographic_Locale</name> <description> <para>The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value. </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="False" position="Named"> <name>Demographic_Make</name> <description> <para>The endpoint make, such as such as Apple or Samsung. </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="False" position="Named"> <name>Demographic_Model</name> <description> <para>The endpoint model, such as iPhone. </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="False" position="Named"> <name>Demographic_ModelVersion</name> <description> <para>The endpoint model version. </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="False" position="Named"> <name>Demographic_Platform</name> <description> <para>The endpoint platform, such as ios or android. </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="False" position="Named"> <name>Demographic_PlatformVersion</name> <description> <para>The endpoint platform version. </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="False" position="Named"> <name>Demographic_Timezone</name> <description> <para>The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles. </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="False" position="Named"> <name>EndpointId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>EndpointRequest_Address</name> <description> <para>The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId). </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="False" position="Named"> <name>EndpointRequest_Attribute</name> <description> <para>Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_ChannelType</name> <description> <para>The channel type.Valid values: GCM | APNS | SMS | EMAIL </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.ChannelType</parameterValue> <type> <name>Amazon.Pinpoint.ChannelType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_EffectiveDate</name> <description> <para>The last time the endpoint was updated. Provided in ISO 8601 format. </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="False" position="Named"> <name>EndpointRequest_EndpointStatus</name> <description> <para>The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated. </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="False" position="Named"> <name>EndpointRequest_Metric</name> <description> <para>Custom metrics that your app reports to Amazon Pinpoint. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointRequest_OptOut</name> <description> <para>Indicates whether a user has opted out of receiving messages with one of the following values:ALL - User has opted out of all messages.NONE - Users has not opted out and receives all messages. </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="False" position="Named"> <name>EndpointRequest_RequestId</name> <description> <para>The unique ID for the most recent request to update the endpoint. </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="False" 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="False" position="Named"> <name>Location_City</name> <description> <para>The city where the endpoint is located. </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="False" position="Named"> <name>Location_Country</name> <description> <para>Country according to ISO 3166-1 Alpha-2 codes. For example, US. </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="False" position="Named"> <name>Location_Latitude</name> <description> <para>The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile). </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_Longitude</name> <description> <para>The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile). </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Location_PostalCode</name> <description> <para>The postal code or zip code of the endpoint. </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="False" position="Named"> <name>Location_Region</name> <description> <para>The region of the endpoint location. For example, corresponds to a state in US. </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="False" position="Named"> <name>User_UserAttribute</name> <description> <para>Custom attributes specific to the user. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>User_UserId</name> <description> <para>The unique ID of the user. </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.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a MessageBody object. The service call response (type Amazon.Pinpoint.Model.UpdateEndpointResponse) 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=Update-PINEndpoint.html&tocid=Update-PINEndpoint</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>Update-PINEndpointsBatch</name> <description> <para>Invokes the UpdateEndpointsBatch operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINEndpointsBatch</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use to update a batch of endpoints. </para> </description> <syntax> <syntaxItem> <name>Update-PINEndpointsBatch</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EndpointBatchRequest_Item</name> <description> <para>List of items to update. Maximum 100 items </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.EndpointBatchItem[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>EndpointBatchRequest_Item</name> <description> <para>List of items to update. Maximum 100 items </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Model.EndpointBatchItem[]</parameterValue> <type> <name>Amazon.Pinpoint.Model.EndpointBatchItem[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.MessageBody</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a MessageBody object. The service call response (type Amazon.Pinpoint.Model.UpdateEndpointsBatchResponse) 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=Update-PINEndpointsBatch.html&tocid=Update-PINEndpointsBatch</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>Update-PINGcmChannel</name> <description> <para>Invokes the UpdateGcmChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINGcmChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use to update the GCM channel for an app. </para> </description> <syntax> <syntaxItem> <name>Update-PINGcmChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMChannelRequest_ApiKey</name> <description> <para>Platform credential API key from Google. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GCMChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>GCMChannelRequest_ApiKey</name> <description> <para>Platform credential API key from Google. </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="False" position="Named"> <name>GCMChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Pinpoint.Model.GCMChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a GCMChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateGcmChannelResponse) 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=Update-PINGcmChannel.html&tocid=Update-PINGcmChannel</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>Update-PINSegment</name> <description> <para>Invokes the UpdateSegment operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINSegment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use to update a segment. </para> </description> <syntax> <syntaxItem> <name>Update-PINSegment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>Custom segment attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_Duration</name> <description> <para>The length of time during which users have been active or inactive with your app.Valid values: HR_24, DAY_7, DAY_14, DAY_30 </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Duration</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteSegmentRequest_Name</name> <description> <para>The name of segment </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_RecencyType</name> <description> <para>The recency dimension type:ACTIVE - Users who have used your app within the specified duration are included in the segment.INACTIVE - Users who have not used your app within the specified duration are included in the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.RecencyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_UserAttribute</name> <description> <para>Custom segment user attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>AppVersion_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppVersion_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Channel_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Channel_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Country_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Country_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>DeviceType_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeviceType_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Dimensions_Attribute</name> <description> <para>Custom segment attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Dimensions_UserAttribute</name> <description> <para>Custom segment user attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Make_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Make_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Model_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Model_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Platform_DimensionType</name> <description> <para>The type of dimension:INCLUSIVE - Endpoints that match the criteria are included in the segment.EXCLUSIVE - Endpoints that match the criteria are excluded from the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.DimensionType</parameterValue> <type> <name>Amazon.Pinpoint.DimensionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Platform_Value</name> <description> <para>The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type. </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="False" position="Named"> <name>Recency_Duration</name> <description> <para>The length of time during which users have been active or inactive with your app.Valid values: HR_24, DAY_7, DAY_14, DAY_30 </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.Duration</parameterValue> <type> <name>Amazon.Pinpoint.Duration</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Recency_RecencyType</name> <description> <para>The recency dimension type:ACTIVE - Users who have used your app within the specified duration are included in the segment.INACTIVE - Users who have not used your app within the specified duration are included in the segment. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Pinpoint.RecencyType</parameterValue> <type> <name>Amazon.Pinpoint.RecencyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SegmentId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>WriteSegmentRequest_Name</name> <description> <para>The name of segment </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.Pinpoint.Model.SegmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SegmentResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateSegmentResponse) 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=Update-PINSegment.html&tocid=Update-PINSegment</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>Update-PINSmsChannel</name> <description> <para>Invokes the UpdateSmsChannel operation against Amazon Pinpoint.</para> </description> <verb>Update</verb> <noun>PINSmsChannel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Update an SMS channel </para> </description> <syntax> <syntaxItem> <name>Update-PINSmsChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_SenderId</name> <description> <para>Sender identifier of your messages. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_ShortCode</name> <description> <para>ShortCode registered with phone provider. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" 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="False" position="Named"> <name>SMSChannelRequest_Enabled</name> <description> <para>If the channel is enabled for sending messages. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SMSChannelRequest_SenderId</name> <description> <para>Sender identifier of your messages. </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="False" position="Named"> <name>SMSChannelRequest_ShortCode</name> <description> <para>ShortCode registered with phone provider. </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.Pinpoint.Model.SMSChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SMSChannelResponse object. The service call response (type Amazon.Pinpoint.Model.UpdateSmsChannelResponse) 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=Update-PINSmsChannel.html&tocid=Update-PINSmsChannel</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>Write-PINEventStream</name> <description> <para>Invokes the PutEventStream operation against Amazon Pinpoint.</para> </description> <verb>Write</verb> <noun>PINEventStream</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Use to create or update the event stream for an app. </para> </description> <syntax> <syntaxItem> <name>Write-PINEventStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>ApplicationId </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteEventStream_DestinationStreamArn</name> <description> <para>The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WriteEventStream_RoleArn</name> <description> <para>The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ApplicationId</name> <description> <para>ApplicationId </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="False" 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="False" position="Named"> <name>WriteEventStream_DestinationStreamArn</name> <description> <para>The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME </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="False" position="Named"> <name>WriteEventStream_RoleArn</name> <description> <para>The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account. </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.Pinpoint.Model.EventStream</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a EventStream object. The service call response (type Amazon.Pinpoint.Model.PutEventStreamResponse) 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=Write-PINEventStream.html&tocid=Write-PINEventStream</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>Add-ORGPolicy</name> <description> <para>Invokes the AttachPolicy operation against AWS Organizations.</para> </description> <verb>Add</verb> <noun>ORGPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Attaches a policy to a root, an organizational unit, or an individual account. How the policy affects accounts depends on the type of policy: - <b>Service control policy (SCP)</b> - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to: - If you attach an SCP to a root, it affects all accounts in the organization. - If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs. - If you attach the policy directly to an account, then it affects only that account. SCPs essentially are permission "filters". When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP. AWS Organizations attaches a default SCP named <code>"FullAWSAccess</code> to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account. For more information about how Organizations policies permissions work, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html">Using Service Control Policies</a> in the <i>AWS Organizations User Guide</i>. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Add-ORGPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the <a>ListPolicies</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetId</name> <description> <para>The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a target ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Account: a string that consists of exactly 12 digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the <a>ListPolicies</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </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="False" position="Named"> <name>TargetId</name> <description> <para>The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a target ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Account: a string that consists of exactly 12 digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PolicyId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Organizations.Model.AttachPolicyResponse) 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=Add-ORGPolicy.html&tocid=Add-ORGPolicy</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>Confirm-ORGHandshake</name> <description> <para>Invokes the AcceptHandshake operation against AWS Organizations.</para> </description> <verb>Confirm</verb> <noun>ORGHandshake</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request. This operation can be called only by the following principals when they also have the relevant IAM permissions: - <b>Invitation to join</b> or <b>Approve all features request</b> handshakes: only a principal from the member account. The user who calls the API for an invitation to join must have the <code>organizations:AcceptHandshake</code> permission. If you enabled all features in the organization, then the user must also have the <code>iam:CreateServiceLinkedRole</code> permission so that Organizations can create the required service-linked role named <i>OrgsServiceLinkedRoleName</i>. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integration_service-linked-roles">AWS Organizations and Service-Linked Roles</a> in the <i>AWS Organizations User Guide</i>. - <b>Enable all features final confirmation</b> handshake: only a principal from the master account. For more information about invitations, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html">Inviting an AWS Account to Join Your Organization</a> in the <i>AWS Organizations User Guide</i>. For more information about requests to enable all features in the organization, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling All Features in Your Organization</a> in the <i>AWS Organizations User Guide</i>. After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. </para> </description> <syntax> <syntaxItem> <name>Confirm-ORGHandshake</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HandshakeId</name> <description> <para>The unique identifier (ID) of the handshake that you want to accept. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>HandshakeId</name> <description> <para>The unique identifier (ID) of the handshake that you want to accept. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </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.Organizations.Model.Handshake</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Handshake object. The service call response (type Amazon.Organizations.Model.AcceptHandshakeResponse) 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=Confirm-ORGHandshake.html&tocid=Confirm-ORGHandshake</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>Deny-ORGHandshake</name> <description> <para>Invokes the DeclineHandshake operation against AWS Organizations.</para> </description> <verb>Deny</verb> <noun>ORGHandshake</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Declines a handshake request. This sets the handshake state to <code>DECLINED</code> and effectively deactivates the request. This operation can be called only from the account that received the handshake. The originator of the handshake can use <a>CancelHandshake</a> instead. The originator can't reactivate a declined request, but can re-initiate the process with a new handshake request. After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. </para> </description> <syntax> <syntaxItem> <name>Deny-ORGHandshake</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HandshakeId</name> <description> <para>The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the <a>ListHandshakesForAccount</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>HandshakeId</name> <description> <para>The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the <a>ListHandshakesForAccount</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </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.Organizations.Model.Handshake</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Handshake object. The service call response (type Amazon.Organizations.Model.DeclineHandshakeResponse) 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=Deny-ORGHandshake.html&tocid=Deny-ORGHandshake</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>Disable-ORGPolicyType</name> <description> <para>Invokes the DisablePolicyType operation against AWS Organizations.</para> </description> <verb>Disable</verb> <noun>ORGPolicyType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any OU or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Disable-ORGPolicyType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyType</name> <description> <para>The policy type that you want to disable in this root. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RootId</name> <description> <para>The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the <a>ListRoots</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>PolicyType</name> <description> <para>The policy type that you want to disable in this root. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> <type> <name>Amazon.Organizations.PolicyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RootId</name> <description> <para>The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the <a>ListRoots</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits. </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.Organizations.Model.Root</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Root object. The service call response (type Amazon.Organizations.Model.DisablePolicyTypeResponse) 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=Disable-ORGPolicyType.html&tocid=Disable-ORGPolicyType</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>Dismount-ORGPolicy</name> <description> <para>Invokes the DetachPolicy operation against AWS Organizations.</para> </description> <verb>Dismount</verb> <noun>ORGPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Detaches a policy from a target root, organizational unit, or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate. <b>Note:</b> Every root, OU, and account must have at least one SCP attached. If you want to replace the default <code>FullAWSAccess</code> policy with one that limits the permissions that can be delegated, then you must attach the replacement policy before you can remove the default one. This is the authorization strategy of <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html#orgs_policies_whitelist">whitelisting</a>. If you instead attach a second SCP and leave the <code>FullAWSAccess</code> SCP still attached, and specify <code>"Effect": "Deny"</code> in the second SCP to override the <code>"Effect": "Allow"</code> in the <code>FullAWSAccess</code> policy (or any other attached SCP), then you are using the authorization strategy of <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html#orgs_policies_blacklist">blacklisting</a>. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Dismount-ORGPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy you want to detach. You can get the ID from the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TargetId</name> <description> <para>The unique identifier (ID) of the root, OU, or account from which you want to detach the policy. You can get the ID from the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a target ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Account: a string that consists of exactly 12 digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy you want to detach. You can get the ID from the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </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="False" position="Named"> <name>TargetId</name> <description> <para>The unique identifier (ID) of the root, OU, or account from which you want to detach the policy. You can get the ID from the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a target ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Account: a string that consists of exactly 12 digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PolicyId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Organizations.Model.DetachPolicyResponse) 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=Dismount-ORGPolicy.html&tocid=Dismount-ORGPolicy</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>Enable-ORGAllFeature</name> <description> <para>Invokes the EnableAllFeatures operation against AWS Organizations.</para> </description> <verb>Enable</verb> <noun>ORGAllFeature</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">Enabling All Features in Your Organization</a> in the <i>AWS Organizations User Guide</i>. <important><para> This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled, or that were migrated from a Consolidated Billing account family to Organizations. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake. </para></important> After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains <code>"Action": "ENABLE_ALL_FEATURES"</code>. This completes the change. After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Enable-ORGAllFeature</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Organizations.Model.Handshake</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Handshake object. The service call response (type Amazon.Organizations.Model.EnableAllFeaturesResponse) 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=Enable-ORGAllFeature.html&tocid=Enable-ORGAllFeature</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>Enable-ORGPolicyType</name> <description> <para>Invokes the EnablePolicyType operation against AWS Organizations.</para> </description> <verb>Enable</verb> <noun>ORGPolicyType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any OU, or account in that root. You can undo this by using the <a>DisablePolicyType</a> operation. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Enable-ORGPolicyType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyType</name> <description> <para>The policy type that you want to enable. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RootId</name> <description> <para>The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the <a>ListRoots</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>PolicyType</name> <description> <para>The policy type that you want to enable. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> <type> <name>Amazon.Organizations.PolicyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RootId</name> <description> <para>The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the <a>ListRoots</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits. </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.Organizations.Model.Root</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Root object. The service call response (type Amazon.Organizations.Model.EnablePolicyTypeResponse) 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=Enable-ORGPolicyType.html&tocid=Enable-ORGPolicyType</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>Get-ORGAccount</name> <description> <para>Invokes the DescribeAccount operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGAccount</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves Organizations-related information about the specified account. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Get-ORGAccount</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the <a>ListAccounts</a> or <a>ListAccountsForParent</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12 digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the <a>ListAccounts</a> or <a>ListAccountsForParent</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12 digits. </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.Organizations.Model.Account</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Account object. The service call response (type Amazon.Organizations.Model.DescribeAccountResponse) 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-ORGAccount.html&tocid=Get-ORGAccount</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>Get-ORGAccountCreationStatus</name> <description> <para>Invokes the DescribeCreateAccountStatus operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGAccountCreationStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the current status of an asynchronous request to create an account. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Get-ORGAccountCreationStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreateAccountRequestId</name> <description> <para>Specifies the <code>operationId</code> that uniquely identifies the request. You can get the ID from the response to an earlier <a>CreateAccount</a> request, or from the <a>ListCreateAccountStatus</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreateAccountRequestId</name> <description> <para>Specifies the <code>operationId</code> that uniquely identifies the request. You can get the ID from the response to an earlier <a>CreateAccount</a> request, or from the <a>ListCreateAccountStatus</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an create account request ID string requires "car-" followed by from 8 to 32 lower-case letters or digits. </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.Organizations.Model.CreateAccountStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CreateAccountStatus object. The service call response (type Amazon.Organizations.Model.DescribeCreateAccountStatusResponse) 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-ORGAccountCreationStatus.html&tocid=Get-ORGAccountCreationStatus</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>Get-ORGAccountCreationStatusList</name> <description> <para>Invokes the ListCreateAccountStatus operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGAccountCreationStatusList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the account creation requests that match the specified status that is currently being tracked for the organization. This operation can be called only from the organization's master account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGAccountCreationStatusList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>State</name> <description> <para>A list of one or more states that you want included in the response. If this parameter is not present, then all requests are included in the response. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>State</name> <description> <para>A list of one or more states that you want included in the response. If this parameter is not present, then all requests are included in the response. </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.Organizations.Model.CreateAccountStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of CreateAccountStatus objects. The service call response (type Amazon.Organizations.Model.ListCreateAccountStatusResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGAccountCreationStatusList.html&tocid=Get-ORGAccountCreationStatusList</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>Get-ORGAccountForParent</name> <description> <para>Invokes the ListAccountsForParent operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGAccountForParent</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that are not in any OU. If you specify an OU, you get a list of all the accounts in only that OU, and not in any child OUs. To get a list of all accounts in the organization, use the <a>ListAccounts</a> operation.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGAccountForParent</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ParentId</name> <description> <para>The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ParentId</name> <description> <para>The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list. </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.Organizations.Model.Account</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Account objects. The service call response (type Amazon.Organizations.Model.ListAccountsForParentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGAccountForParent.html&tocid=Get-ORGAccountForParent</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>Get-ORGAccountHandshakeList</name> <description> <para>Invokes the ListHandshakesForAccount operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGAccountHandshakeList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the current handshakes that are associated with the account of the requesting user. Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible. This operation can be called from any account in the organization. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGAccountHandshakeList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_ActionType</name> <description> <para>Specifies the type of handshake action. If you specify <code>ActionType</code>, you cannot also specify <code>ParentHandshakeId</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.ActionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_ParentHandshakeId</name> <description> <para>Specifies the parent handshake. Only used for handshake types that are a child of another type. If you specify <code>ParentHandshakeId</code>, you cannot also specify <code>ActionType</code>. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_ActionType</name> <description> <para>Specifies the type of handshake action. If you specify <code>ActionType</code>, you cannot also specify <code>ParentHandshakeId</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.ActionType</parameterValue> <type> <name>Amazon.Organizations.ActionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_ParentHandshakeId</name> <description> <para>Specifies the parent handshake. Only used for handshake types that are a child of another type. If you specify <code>ParentHandshakeId</code>, you cannot also specify <code>ActionType</code>. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </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="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Organizations.Model.Handshake</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Handshake objects. The service call response (type Amazon.Organizations.Model.ListHandshakesForAccountResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGAccountHandshakeList.html&tocid=Get-ORGAccountHandshakeList</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>Get-ORGAccountList</name> <description> <para>Invokes the ListAccounts operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGAccountList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all the accounts in the organization. To request only the accounts in a root or OU, use the <a>ListAccountsForParent</a> operation instead. This operation can be called only from the organization's master account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGAccountList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Organizations.Model.Account</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Account objects. The service call response (type Amazon.Organizations.Model.ListAccountsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGAccountList.html&tocid=Get-ORGAccountList</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>Get-ORGChild</name> <description> <para>Invokes the ListChildren operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGChild</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all of the OUs or accounts that are contained in the specified parent OU or root. This operation, along with <a>ListParents</a> enables you to traverse the tree structure that makes up this root.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGChild</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ParentId</name> <description> <para>The unique identifier (ID) for the parent root or OU whose children you want to list. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChildType</name> <description> <para>Filters the output to include only the specified child type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.ChildType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChildType</name> <description> <para>Filters the output to include only the specified child type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.ChildType</parameterValue> <type> <name>Amazon.Organizations.ChildType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ParentId</name> <description> <para>The unique identifier (ID) for the parent root or OU whose children you want to list. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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.Organizations.Model.Child</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Child objects. The service call response (type Amazon.Organizations.Model.ListChildrenResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGChild.html&tocid=Get-ORGChild</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>Get-ORGHandshake</name> <description> <para>Invokes the DescribeHandshake operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGHandshake</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original <a>InviteAccountToOrganization</a> operation that generated the handshake. You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They are then deleted and no longer accessible. This operation can be called from any account in the organization. </para> </description> <syntax> <syntaxItem> <name>Get-ORGHandshake</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HandshakeId</name> <description> <para>The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to <a>InviteAccountToOrganization</a>, or from a call to <a>ListHandshakesForAccount</a> or <a>ListHandshakesForOrganization</a>. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HandshakeId</name> <description> <para>The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to <a>InviteAccountToOrganization</a>, or from a call to <a>ListHandshakesForAccount</a> or <a>ListHandshakesForOrganization</a>. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </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.Organizations.Model.Handshake</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Handshake object. The service call response (type Amazon.Organizations.Model.DescribeHandshakeResponse) 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-ORGHandshake.html&tocid=Get-ORGHandshake</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>Get-ORGOrganization</name> <description> <para>Invokes the DescribeOrganization operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGOrganization</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about the organization that the user's account belongs to. This operation can be called from any account in the organization. </para> </description> <syntax> <syntaxItem> <name>Get-ORGOrganization</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.Organizations.Model.Organization</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Organization object. The service call response (type Amazon.Organizations.Model.DescribeOrganizationResponse) 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-ORGOrganization.html&tocid=Get-ORGOrganization</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>Get-ORGOrganizationalUnit</name> <description> <para>Invokes the DescribeOrganizationalUnit operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGOrganizationalUnit</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about an organizational unit (OU). This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Get-ORGOrganizationalUnit</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OrganizationalUnitId</name> <description> <para>The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the <a>ListOrganizationalUnitsForParent</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OrganizationalUnitId</name> <description> <para>The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the <a>ListOrganizationalUnitsForParent</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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.Organizations.Model.OrganizationalUnit</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a OrganizationalUnit object. The service call response (type Amazon.Organizations.Model.DescribeOrganizationalUnitResponse) 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-ORGOrganizationalUnit.html&tocid=Get-ORGOrganizationalUnit</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>Get-ORGOrganizationalUnitList</name> <description> <para>Invokes the ListOrganizationalUnitsForParent operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGOrganizationalUnitList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the organizational units (OUs) in a parent organizational unit or root. This operation can be called only from the organization's master account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGOrganizationalUnitList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ParentId</name> <description> <para>The unique identifier (ID) of the root or OU whose child OUs you want to list. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ParentId</name> <description> <para>The unique identifier (ID) of the root or OU whose child OUs you want to list. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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.Organizations.Model.OrganizationalUnit</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of OrganizationalUnit objects. The service call response (type Amazon.Organizations.Model.ListOrganizationalUnitsForParentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGOrganizationalUnitList.html&tocid=Get-ORGOrganizationalUnitList</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>Get-ORGOrganizationHandshakeList</name> <description> <para>Invokes the ListHandshakesForOrganization operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGOrganizationHandshakeList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the handshakes that are associated with the organization that the requesting user is part of. The <code>ListHandshakesForOrganization</code> operation returns a list of handshake structures. Each structure contains details and status about a handshake. Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that they are deleted and no longer accessible. This operation can be called only from the organization's master account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGOrganizationHandshakeList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_ActionType</name> <description> <para>Specifies the type of handshake action. If you specify <code>ActionType</code>, you cannot also specify <code>ParentHandshakeId</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.ActionType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_ParentHandshakeId</name> <description> <para>Specifies the parent handshake. Only used for handshake types that are a child of another type. If you specify <code>ParentHandshakeId</code>, you cannot also specify <code>ActionType</code>. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_ActionType</name> <description> <para>Specifies the type of handshake action. If you specify <code>ActionType</code>, you cannot also specify <code>ParentHandshakeId</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.ActionType</parameterValue> <type> <name>Amazon.Organizations.ActionType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter_ParentHandshakeId</name> <description> <para>Specifies the parent handshake. Only used for handshake types that are a child of another type. If you specify <code>ParentHandshakeId</code>, you cannot also specify <code>ActionType</code>. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </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="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Organizations.Model.Handshake</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Handshake objects. The service call response (type Amazon.Organizations.Model.ListHandshakesForOrganizationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGOrganizationHandshakeList.html&tocid=Get-ORGOrganizationHandshakeList</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>Get-ORGParent</name> <description> <para>Invokes the ListParents operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGParent</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with <a>ListChildren</a> enables you to traverse the tree structure that makes up this root. This operation can be called only from the organization's master account. In the current release, a child can have only a single parent. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGParent</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChildId</name> <description> <para>The unique identifier (ID) of the OU or account whose parent containers you want to list. Do not specify a root. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a child ID string requires one of the following: - Account: a string that consists of exactly 12 digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ChildId</name> <description> <para>The unique identifier (ID) of the OU or account whose parent containers you want to list. Do not specify a root. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a child ID string requires one of the following: - Account: a string that consists of exactly 12 digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Organizations.Model.Parent</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Parent objects. The service call response (type Amazon.Organizations.Model.ListParentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGParent.html&tocid=Get-ORGParent</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>Get-ORGPolicy</name> <description> <para>Invokes the DescribePolicy operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves information about a policy. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Get-ORGPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy that you want details about. You can get the ID from the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy that you want details about. You can get the ID from the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </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.Organizations.Model.Policy</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Policy object. The service call response (type Amazon.Organizations.Model.DescribePolicyResponse) 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-ORGPolicy.html&tocid=Get-ORGPolicy</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>Get-ORGPolicyForTarget</name> <description> <para>Invokes the ListPoliciesForTarget operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGPolicyForTarget</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list. This operation can be called only from the organization's master account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGPolicyForTarget</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>TargetId</name> <description> <para>The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a target ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Account: a string that consists of exactly 12 digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>The type of policy that you want to include in the returned list. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>The type of policy that you want to include in the returned list. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> <type> <name>Amazon.Organizations.PolicyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>TargetId</name> <description> <para>The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a target ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Account: a string that consists of exactly 12 digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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.Organizations.Model.PolicySummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PolicySummary objects. The service call response (type Amazon.Organizations.Model.ListPoliciesForTargetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGPolicyForTarget.html&tocid=Get-ORGPolicyForTarget</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>Get-ORGPolicyList</name> <description> <para>Invokes the ListPolicies operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGPolicyList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves the list of all policies in an organization of a specified type. This operation can be called only from the organization's master account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGPolicyList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Filter</name> <description> <para>Specifies the type of policy that you want to include in the response. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Filter</name> <description> <para>Specifies the type of policy that you want to include in the response. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> <type> <name>Amazon.Organizations.PolicyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Organizations.Model.PolicySummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PolicySummary objects. The service call response (type Amazon.Organizations.Model.ListPoliciesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGPolicyList.html&tocid=Get-ORGPolicyList</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>Get-ORGRoot</name> <description> <para>Invokes the ListRoots operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGRoot</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the roots that are defined in the current organization. This operation can be called only from the organization's master account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGRoot</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.Organizations.Model.Root</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Root objects. The service call response (type Amazon.Organizations.Model.ListRootsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGRoot.html&tocid=Get-ORGRoot</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>Get-ORGTargetForPolicy</name> <description> <para>Invokes the ListTargetsForPolicy operation against AWS Organizations.</para> </description> <verb>Get</verb> <noun>ORGTargetForPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all the roots, OUs, and accounts to which the specified policy is attached. This operation can be called only from the organization's master account. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-ORGTargetForPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy for which you want to know its attachments. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>(Optional) Use this to limit the number of results you want included in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy for which you want to know its attachments. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </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.Organizations.Model.PolicyTargetSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of PolicyTargetSummary objects. The service call response (type Amazon.Organizations.Model.ListTargetsForPolicyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-ORGTargetForPolicy.html&tocid=Get-ORGTargetForPolicy</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>Move-ORGAccount</name> <description> <para>Invokes the MoveAccount operation against AWS Organizations.</para> </description> <verb>Move</verb> <noun>ORGAccount</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Moves an account from its current source parent root or OU to the specified destination parent root or OU. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Move-ORGAccount</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The unique identifier (ID) of the account that you want to move. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12 digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DestinationParentId</name> <description> <para>The unique identifier (ID) of the root or organizational unit that you want to move the account to. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SourceParentId</name> <description> <para>The unique identifier (ID) of the root or organizational unit that you want to move the account from. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The unique identifier (ID) of the account that you want to move. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12 digits. </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="False" position="Named"> <name>DestinationParentId</name> <description> <para>The unique identifier (ID) of the root or organizational unit that you want to move the account to. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>SourceParentId</name> <description> <para>The unique identifier (ID) of the root or organizational unit that you want to move the account from. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AccountId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Organizations.Model.MoveAccountResponse) 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=Move-ORGAccount.html&tocid=Move-ORGAccount</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>New-ORGAccount</name> <description> <para>Invokes the CreateAccount operation against AWS Organizations.</para> </description> <verb>New</verb> <noun>ORGAccount</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. If you want to check the status of the request later, you need the <code>OperationId</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation. The user who calls the API for an invitation to join must have the <code>organizations:CreateAccount</code> permission. If you enabled all features in the organization, then the user must also have the <code>iam:CreateServiceLinkedRole</code> permission so that Organizations can create the required service-linked role named <i>OrgsServiceLinkedRoleName</i>. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integration_service-linked-roles">AWS Organizations and Service-Linked Roles</a> in the <i>AWS Organizations User Guide</i>. The user in the master account who calls this API must also have the <code>iam:CreateRole</code> permission because AWS Organizations preconfigures the new member account with a role (named <code>OrganizationAccountAccessRole</code> by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account. For more information about creating accounts, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html">Creating an AWS Account in Your Organization</a> in the <i>AWS Organizations User Guide</i>. <important><para> When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the End User Licence Agreement (EULA) is <i>not</i> automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info"> To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>. </para></important> When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable this, then only the account root user can access billing information. For information about how to disable this for an account, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html">Granting Access to Your Billing Information and Tools</a>. This operation can be called only from the organization's master account. <important><para> If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact <a href="https://console.aws.amazon.com/support/home#/"> AWS Customer Support</a>. </para></important> </para> </description> <syntax> <syntaxItem> <name>New-ORGAccount</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountName</name> <description> <para>The friendly name of the member account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Email</name> <description> <para>The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You cannot access the root user of the account or remove an account that was created with an invalid email address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IamUserAccessToBilling</name> <description> <para>If set to <code>ALLOW</code>, the new account enables IAM users to access account billing information <i>if</i> they have the required permissions. If set to <code>DENY</code>, then only the root user of the new account can access account billing information. For more information, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>. If you do not specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.IAMUserAccessToBilling</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleName</name> <description> <para>(Optional) The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account. If you do not specify this parameter, the role name defaults to <code>OrganizationAccountAccessRole</code>. For more information about how to use this role to access the member account, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role">Accessing and Administering the Member Accounts in Your Organization</a> in the <i>AWS Organizations User Guide</i>, and steps 2 and 3 in <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html">Tutorial: Delegate Access Across AWS Accounts Using IAM Roles</a> in the <i>IAM User Guide</i>. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of characters that can consist of uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@- </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountName</name> <description> <para>The friendly name of the member account. </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="False" position="Named"> <name>Email</name> <description> <para>The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You cannot access the root user of the account or remove an account that was created with an invalid email address. </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="False" 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="False" position="Named"> <name>IamUserAccessToBilling</name> <description> <para>If set to <code>ALLOW</code>, the new account enables IAM users to access account billing information <i>if</i> they have the required permissions. If set to <code>DENY</code>, then only the root user of the new account can access account billing information. For more information, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>. If you do not specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.IAMUserAccessToBilling</parameterValue> <type> <name>Amazon.Organizations.IAMUserAccessToBilling</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RoleName</name> <description> <para>(Optional) The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account. If you do not specify this parameter, the role name defaults to <code>OrganizationAccountAccessRole</code>. For more information about how to use this role to access the member account, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role">Accessing and Administering the Member Accounts in Your Organization</a> in the <i>AWS Organizations User Guide</i>, and steps 2 and 3 in <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html">Tutorial: Delegate Access Across AWS Accounts Using IAM Roles</a> in the <i>IAM User Guide</i>. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of characters that can consist of uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@- </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.Organizations.Model.CreateAccountStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CreateAccountStatus object. The service call response (type Amazon.Organizations.Model.CreateAccountResponse) 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=New-ORGAccount.html&tocid=New-ORGAccount</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>New-ORGAccountInvitation</name> <description> <para>Invokes the InviteAccountToOrganization operation against AWS Organizations.</para> </description> <verb>New</verb> <noun>ORGAccountInvitation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a <a>Handshake</a> whose details are in the response. <important><para> You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilliing-India.html">Consolidated Billing in India</a>. </para></important> This operation can be called only from the organization's master account. <important><para> If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact <a href="https://console.aws.amazon.com/support/home#/"> AWS Customer Support</a>. </para></important> </para> </description> <syntax> <syntaxItem> <name>New-ORGAccountInvitation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target_Id</name> <description> <para>The unique identifier (ID) for the party. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Note</name> <description> <para>Additional information that you want to include in the generated email to the recipient account owner. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Target_Type</name> <description> <para>The type of party. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.HandshakePartyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Note</name> <description> <para>Additional information that you want to include in the generated email to the recipient account owner. </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="False" position="Named"> <name>Target_Id</name> <description> <para>The unique identifier (ID) for the party. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </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="False" position="Named"> <name>Target_Type</name> <description> <para>The type of party. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.HandshakePartyType</parameterValue> <type> <name>Amazon.Organizations.HandshakePartyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Organizations.Model.Handshake</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Handshake object. The service call response (type Amazon.Organizations.Model.InviteAccountToOrganizationResponse) 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=New-ORGAccountInvitation.html&tocid=New-ORGAccountInvitation</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>New-ORGOrganization</name> <description> <para>Invokes the CreateOrganization operation against AWS Organizations.</para> </description> <verb>New</verb> <noun>ORGOrganization</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/orgs_getting-started_concepts.html#account">master account</a> of the new organization. This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions. By default (or if you set the <code>FeatureSet</code> parameter to <code>ALL</code>), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the <code>FeatureSet</code> parameter to <code>CONSOLIDATED_BILLING"</code>, then no policy types are enabled by default and you cannot use organization policies. </para> </description> <syntax> <syntaxItem> <name>New-ORGOrganization</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FeatureSet</name> <description> <para>Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality. - <i>CONSOLIDATED_BILLING</i>: All member accounts have their bills consolidated to and paid by the master account. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only">Consolidated Billing</a> in the <i>AWS Organizations User Guide</i>. - <i>ALL</i>: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any type of policy to any member account in the organization. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all">All features</a> in the <i>AWS Organizations User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.OrganizationFeatureSet</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>FeatureSet</name> <description> <para>Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality. - <i>CONSOLIDATED_BILLING</i>: All member accounts have their bills consolidated to and paid by the master account. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only">Consolidated Billing</a> in the <i>AWS Organizations User Guide</i>. - <i>ALL</i>: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any type of policy to any member account in the organization. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all">All features</a> in the <i>AWS Organizations User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.OrganizationFeatureSet</parameterValue> <type> <name>Amazon.Organizations.OrganizationFeatureSet</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Organizations.Model.Organization</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Organization object. The service call response (type Amazon.Organizations.Model.CreateOrganizationResponse) 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=New-ORGOrganization.html&tocid=New-ORGOrganization</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>New-ORGOrganizationalUnit</name> <description> <para>Invokes the CreateOrganizationalUnit operation against AWS Organizations.</para> </description> <verb>New</verb> <noun>ORGOrganizationalUnit</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five. For more information about OUs, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html">Managing Organizational Units</a> in the <i>AWS Organizations User Guide</i>. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>New-ORGOrganizationalUnit</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The friendly name to assign to the new OU. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ParentId</name> <description> <para>The unique identifier (ID) of the parent root or OU in which you want to create the new OU. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The friendly name to assign to the new OU. </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="False" position="Named"> <name>ParentId</name> <description> <para>The unique identifier (ID) of the parent root or OU in which you want to create the new OU. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a parent ID string requires one of the following: - Root: a string that begins with "r-" followed by from 4 to 32 lower-case letters or digits. - Organizational unit (OU): a string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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.Organizations.Model.OrganizationalUnit</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a OrganizationalUnit object. The service call response (type Amazon.Organizations.Model.CreateOrganizationalUnitResponse) 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=New-ORGOrganizationalUnit.html&tocid=New-ORGOrganizationalUnit</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>New-ORGPolicy</name> <description> <para>Invokes the CreatePolicy operation against AWS Organizations.</para> </description> <verb>New</verb> <noun>ORGPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account. For more information about policies and their use, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html">Managing Organization Policies</a>. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>New-ORGPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The friendly name to assign to the policy. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Content</name> <description> <para>The policy content to add to the new policy. For example, if you create a <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html">service control policy</a> (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html">Service Control Policy Syntax</a> in the <i>AWS Organizations User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>An optional description to assign to the policy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Type</name> <description> <para>The type of policy to create. In the current release, the only type of policy that you can create is a service control policy (SCP). </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Content</name> <description> <para>The policy content to add to the new policy. For example, if you create a <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html">service control policy</a> (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html">Service Control Policy Syntax</a> in the <i>AWS Organizations User Guide</i>. </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="False" position="Named"> <name>Description</name> <description> <para>An optional description to assign to the policy. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The friendly name to assign to the policy. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range. </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="False" position="Named"> <name>Type</name> <description> <para>The type of policy to create. In the current release, the only type of policy that you can create is a service control policy (SCP). </para> </description> <parameterValue required="true" variableLength="false">Amazon.Organizations.PolicyType</parameterValue> <type> <name>Amazon.Organizations.PolicyType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.Organizations.Model.Policy</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Policy object. The service call response (type Amazon.Organizations.Model.CreatePolicyResponse) 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=New-ORGPolicy.html&tocid=New-ORGPolicy</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-ORGAccountFromOrganization</name> <description> <para>Invokes the RemoveAccountFromOrganization operation against AWS Organizations.</para> </description> <verb>Remove</verb> <noun>ORGAccountFromOrganization</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes the specified account from the organization. The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization. This operation can be called only from the organization's master account. Member accounts can remove themselves with <a>LeaveOrganization</a> instead. <important><ul><li><para> You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is <i>not</i> automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info"> To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>. </para></li><li><para> You can remove a member account only after you enable IAM user access to billing in the member account. For more information, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para></li></ul></important> </para> </description> <syntax> <syntaxItem> <name>Remove-ORGAccountFromOrganization</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The unique identifier (ID) of the member account that you want to remove from the organization. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12 digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AccountId</name> <description> <para>The unique identifier (ID) of the member account that you want to remove from the organization. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an account ID string requires exactly 12 digits. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AccountId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Organizations.Model.RemoveAccountFromOrganizationResponse) 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-ORGAccountFromOrganization.html&tocid=Remove-ORGAccountFromOrganization</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-ORGOrganization</name> <description> <para>Invokes the DeleteOrganization operation against AWS Organizations.</para> </description> <verb>Remove</verb> <noun>ORGOrganization</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts, OUs, and policies. </para> </description> <syntax> <syntaxItem> <name>Remove-ORGOrganization</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.Organizations.Model.DeleteOrganizationResponse) 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-ORGOrganization.html&tocid=Remove-ORGOrganization</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-ORGOrganizationalUnit</name> <description> <para>Invokes the DeleteOrganizationalUnit operation against AWS Organizations.</para> </description> <verb>Remove</verb> <noun>ORGOrganizationalUnit</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an organizational unit from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Remove-ORGOrganizationalUnit</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>OrganizationalUnitId</name> <description> <para>The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the <a>ListOrganizationalUnitsForParent</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the OrganizationalUnitId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>OrganizationalUnitId</name> <description> <para>The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the <a>ListOrganizationalUnitsForParent</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the OrganizationalUnitId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the OrganizationalUnitId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Organizations.Model.DeleteOrganizationalUnitResponse) 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-ORGOrganizationalUnit.html&tocid=Remove-ORGOrganizationalUnit</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-ORGOrganizationAssociation</name> <description> <para>Invokes the LeaveOrganization operation against AWS Organizations.</para> </description> <verb>Remove</verb> <noun>ORGOrganizationAssociation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use <a>RemoveAccountFromOrganization</a> instead. This operation can be called only from a member account in the organization. <important><ul><li><para> The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do, including preventing them from successfully calling <code>LeaveOrganization</code> and leaving the organization. </para></li><li><para> You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is <i>not</i> automatically collected. For each account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. Follow the steps at <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info"> To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>. </para></li><li><para> You can leave an organization only after you enable IAM user access to billing in your account. For more information, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para></li></ul></important> </para> </description> <syntax> <syntaxItem> <name>Remove-ORGOrganizationAssociation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.Organizations.Model.LeaveOrganizationResponse) 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-ORGOrganizationAssociation.html&tocid=Remove-ORGOrganizationAssociation</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-ORGPolicy</name> <description> <para>Invokes the DeletePolicy operation against AWS Organizations.</para> </description> <verb>Remove</verb> <noun>ORGPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all OUs, roots, and accounts. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Remove-ORGPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy that you want to delete. You can get the ID from the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy that you want to delete. You can get the ID from the <a>ListPolicies</a> or <a>ListPoliciesForTarget</a> operations. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PolicyId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.Organizations.Model.DeletePolicyResponse) 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-ORGPolicy.html&tocid=Remove-ORGPolicy</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>Stop-ORGHandshake</name> <description> <para>Invokes the CancelHandshake operation against AWS Organizations.</para> </description> <verb>Stop</verb> <noun>ORGHandshake</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Cancels a handshake. Canceling a handshake sets the handshake state to <code>CANCELED</code>. This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use <a>DeclineHandshake</a> instead. After a handshake is canceled, the recipient can no longer respond to that handshake. After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted. </para> </description> <syntax> <syntaxItem> <name>Stop-ORGHandshake</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HandshakeId</name> <description> <para>The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the <a>ListHandshakesForOrganization</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>HandshakeId</name> <description> <para>The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the <a>ListHandshakesForOrganization</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits. </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.Organizations.Model.Handshake</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Handshake object. The service call response (type Amazon.Organizations.Model.CancelHandshakeResponse) 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=Stop-ORGHandshake.html&tocid=Stop-ORGHandshake</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>Update-ORGOrganizationalUnit</name> <description> <para>Invokes the UpdateOrganizationalUnit operation against AWS Organizations.</para> </description> <verb>Update</verb> <noun>ORGOrganizationalUnit</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Update-ORGOrganizationalUnit</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The new name that you want to assign to the OU. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OrganizationalUnitId</name> <description> <para>The unique identifier (ID) of the OU that you want to rename. You can get the ID from the <a>ListOrganizationalUnitsForParent</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The new name that you want to assign to the OU. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range. </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="False" position="Named"> <name>OrganizationalUnitId</name> <description> <para>The unique identifier (ID) of the OU that you want to rename. You can get the ID from the <a>ListOrganizationalUnitsForParent</a> operation. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for an organizational unit ID string requires "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits. </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.Organizations.Model.OrganizationalUnit</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a OrganizationalUnit object. The service call response (type Amazon.Organizations.Model.UpdateOrganizationalUnitResponse) 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=Update-ORGOrganizationalUnit.html&tocid=Update-ORGOrganizationalUnit</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>Update-ORGPolicy</name> <description> <para>Invokes the UpdatePolicy operation against AWS Organizations.</para> </description> <verb>Update</verb> <noun>ORGPolicy</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type. This operation can be called only from the organization's master account. </para> </description> <syntax> <syntaxItem> <name>Update-ORGPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>If provided, the new name for the policy. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Content</name> <description> <para>If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html">Service Control Policy Syntax</a> in the <i>AWS Organizations User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>If provided, the new description for the policy. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy that you want to update. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Content</name> <description> <para>If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see <a href="http://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html">Service Control Policy Syntax</a> in the <i>AWS Organizations User Guide</i>. </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="False" position="Named"> <name>Description</name> <description> <para>If provided, the new description for the policy. </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="False" 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 (ByValue, )" position="1"> <name>Name</name> <description> <para>If provided, the new name for the policy. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range. </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="False" position="Named"> <name>PolicyId</name> <description> <para>The unique identifier (ID) of the policy that you want to update. The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits. </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.Organizations.Model.Policy</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Policy object. The service call response (type Amazon.Organizations.Model.UpdatePolicyResponse) 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=Update-ORGPolicy.html&tocid=Update-ORGPolicy</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>Add-OPSElasticIp</name> <description> <para>Invokes the AssociateElasticIp operation against AWS OpsWorks.</para> </description> <verb>Add</verb> <noun>OPSElasticIp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling <a>RegisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Add-OPSElasticIp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The Elastic IP address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The Elastic IP address. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.AssociateElasticIpResponse) 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=Add-OPSElasticIp.html&tocid=Add-OPSElasticIp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Add-OPSElasticLoadBalancer</name> <description> <para>Invokes the AttachElasticLoadBalancer operation against AWS OpsWorks.</para> </description> <verb>Add</verb> <noun>OPSElasticLoadBalancer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/layers-elb.html">Elastic Load Balancing</a>. You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html"> Elastic Load Balancing Developer Guide</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Add-OPSElasticLoadBalancer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ElasticLoadBalancerName</name> <description> <para>The Elastic Load Balancing instance's name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>LayerId</name> <description> <para>The ID of the layer that the Elastic Load Balancing instance is to be attached to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ElasticLoadBalancerName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ElasticLoadBalancerName</name> <description> <para>The Elastic Load Balancing instance's name. </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="False" 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="2"> <name>LayerId</name> <description> <para>The ID of the layer that the Elastic Load Balancing instance is to be attached to. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ElasticLoadBalancerName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ElasticLoadBalancerName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.AttachElasticLoadBalancerResponse) 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=Add-OPSElasticLoadBalancer.html&tocid=Add-OPSElasticLoadBalancer</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Add-OPSResourceTag</name> <description> <para>Invokes the TagResource operation against AWS OpsWorks.</para> </description> <verb>Add</verb> <noun>OPSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/tagging.html">Tags</a> in the AWS OpsWorks User Guide. </para> </description> <syntax> <syntaxItem> <name>Add-OPSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The stack or layer's Amazon Resource Number (ARN). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>A map that contains tag keys and tag values that are attached to a stack or layer. - The key cannot be empty. - The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> - The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> - Leading and trailing white spaces are trimmed from both the key and value. - A maximum of 40 tags is allowed for any resource. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The stack or layer's Amazon Resource Number (ARN). </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="False" position="Named"> <name>Tag</name> <description> <para>A map that contains tag keys and tag values that are attached to a stack or layer. - The key cannot be empty. - The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> - The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> - Leading and trailing white spaces are trimmed from both the key and value. - A maximum of 40 tags is allowed for any resource. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.TagResourceResponse) 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=Add-OPSResourceTag.html&tocid=Add-OPSResourceTag</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Add-OPSVolume</name> <description> <para>Invokes the AssignVolume operation against AWS OpsWorks.</para> </description> <verb>Add</verb> <noun>OPSVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling <a>RegisterVolume</a>. After you register the volume, you must call <a>UpdateVolume</a> to specify a mount point before calling <code>AssignVolume</code>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Add-OPSVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VolumeId</name> <description> <para>The volume ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>VolumeId</name> <description> <para>The volume ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.AssignVolumeResponse) 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=Add-OPSVolume.html&tocid=Add-OPSVolume</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Copy-OPSStack</name> <description> <para>Invokes the CloneStack operation against AWS OpsWorks.</para> </description> <verb>Copy</verb> <noun>OPSStack</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a clone of a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html">Clone a Stack</a>. By default, all parameters are set to the values used by the parent stack. <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Copy-OPSStack</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SourceStackId</name> <description> <para>The source stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Name</name> <description> <para>The cloned stack name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>StackRegion</name> <description> <para>The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>A list of stack attributes and values as key/value pairs to be added to the cloned stack. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_BerkshelfVersion</name> <description> <para>The Berkshelf version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloneAppId</name> <description> <para>A list of source stack app IDs to be included in the cloned stack. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ClonePermission</name> <description> <para>Whether to clone the source stack's permissions. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomJson</name> <description> <para>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format: <code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code> For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultAvailabilityZone</name> <description> <para>The cloned stack's default Availability Zone, which must be in the specified region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see the <code>VpcId</code> parameter description. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultInstanceProfileArn</name> <description> <para>The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultOs</name> <description> <para>The stack's operating system, which must be set to one of the following. - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. - A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. The default option is the parent stack's operating system. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultRootDeviceType</name> <description> <para>The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.RootDeviceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSshKeyName</name> <description> <para>A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSubnetId</name> <description> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostnameTheme</name> <description> <para>The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are: - <code>Baked_Goods</code> - <code>Clouds</code> - <code>Europe_Cities</code> - <code>Fruits</code> - <code>Greek_Deities</code> - <code>Legendary_creatures_from_Japan</code> - <code>Planets_and_Moons</code> - <code>Roman_Deities</code> - <code>Scottish_Islands</code> - <code>US_Cities</code> - <code>Wild_Cats</code> To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_ManageBerkshelf</name> <description> <para>Whether to enable Berkshelf. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Name</name> <description> <para>The name. This parameter must be set to "Chef". </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling <a>DescribePermissions</a>. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseCustomCookbook</name> <description> <para>Whether to use custom cookbooks. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseOpsworksSecurityGroup</name> <description> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With <code>UseOpsworksSecurityGroups</code> you can instead provide your own custom security groups. <code>UseOpsworksSecurityGroups</code> has the following settings: - True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group. - False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Version</name> <description> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcId</name> <description> <para>The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later. - If your account supports EC2 Classic, the default value is no VPC. - If your account does not support EC2 Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: - It must belong to a VPC in your account that is in the specified region. - You must specify a value for <code>DefaultSubnetId</code>. For more information on how to use AWS OpsWorks Stacks with a VPC, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html">Running a Stack in a VPC</a>. For more information on default VPC and EC2 Classic, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. </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="False" position="Named"> <name>Attribute</name> <description> <para>A list of stack attributes and values as key/value pairs to be added to the cloned stack. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_BerkshelfVersion</name> <description> <para>The Berkshelf version. </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="False" position="Named"> <name>ChefConfiguration_ManageBerkshelf</name> <description> <para>Whether to enable Berkshelf. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloneAppId</name> <description> <para>A list of source stack app IDs to be included in the cloned stack. </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="False" position="Named"> <name>ClonePermission</name> <description> <para>Whether to clone the source stack's permissions. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Name</name> <description> <para>The name. This parameter must be set to "Chef". </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="False" position="Named"> <name>ConfigurationManager_Version</name> <description> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. </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="False" position="Named"> <name>CustomCookbooksSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>CustomCookbooksSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </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="False" position="Named"> <name>CustomCookbooksSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>CustomCookbooksSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> <type> <name>Amazon.OpsWorks.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </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="False" position="Named"> <name>CustomCookbooksSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </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="False" position="Named"> <name>CustomJson</name> <description> <para>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format: <code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code> For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a> </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="False" position="Named"> <name>DefaultAvailabilityZone</name> <description> <para>The cloned stack's default Availability Zone, which must be in the specified region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see the <code>VpcId</code> parameter description. </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="False" position="Named"> <name>DefaultInstanceProfileArn</name> <description> <para>The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </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="False" position="Named"> <name>DefaultOs</name> <description> <para>The stack's operating system, which must be set to one of the following. - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. - A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. The default option is the parent stack's operating system. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux. </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="False" position="Named"> <name>DefaultRootDeviceType</name> <description> <para>The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.RootDeviceType</parameterValue> <type> <name>Amazon.OpsWorks.RootDeviceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSshKeyName</name> <description> <para>A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </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="False" position="Named"> <name>DefaultSubnetId</name> <description> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </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="False" 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="False" position="Named"> <name>HostnameTheme</name> <description> <para>The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are: - <code>Baked_Goods</code> - <code>Clouds</code> - <code>Europe_Cities</code> - <code>Fruits</code> - <code>Greek_Deities</code> - <code>Legendary_creatures_from_Japan</code> - <code>Planets_and_Moons</code> - <code>Roman_Deities</code> - <code>Scottish_Islands</code> - <code>US_Cities</code> - <code>Wild_Cats</code> To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme. </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="False" position="2"> <name>Name</name> <description> <para>The cloned stack name. </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="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling <a>DescribePermissions</a>. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly. </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 (ByValue, )" position="1"> <name>SourceStackId</name> <description> <para>The source stack ID. </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="False" position="3"> <name>StackRegion</name> <description> <para>The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. </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="False" position="Named"> <name>UseCustomCookbook</name> <description> <para>Whether to use custom cookbooks. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseOpsworksSecurityGroup</name> <description> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With <code>UseOpsworksSecurityGroups</code> you can instead provide your own custom security groups. <code>UseOpsworksSecurityGroups</code> has the following settings: - True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group. - False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcId</name> <description> <para>The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later. - If your account supports EC2 Classic, the default value is no VPC. - If your account does not support EC2 Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: - It must belong to a VPC in your account that is in the specified region. - You must specify a value for <code>DefaultSubnetId</code>. For more information on how to use AWS OpsWorks Stacks with a VPC, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html">Running a Stack in a VPC</a>. For more information on default VPC and EC2 Classic, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.CloneStackResponse) 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=Copy-OPSStack.html&tocid=Copy-OPSStack</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Dismount-OPSElasticLoadBalancer</name> <description> <para>Invokes the DetachElasticLoadBalancer operation against AWS OpsWorks.</para> </description> <verb>Dismount</verb> <noun>OPSElasticLoadBalancer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Detaches a specified Elastic Load Balancing instance from its layer. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Dismount-OPSElasticLoadBalancer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ElasticLoadBalancerName</name> <description> <para>The Elastic Load Balancing instance's name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>LayerId</name> <description> <para>The ID of the layer that the Elastic Load Balancing instance is attached to. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ElasticLoadBalancerName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ElasticLoadBalancerName</name> <description> <para>The Elastic Load Balancing instance's name. </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="False" 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="2"> <name>LayerId</name> <description> <para>The ID of the layer that the Elastic Load Balancing instance is attached to. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ElasticLoadBalancerName parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ElasticLoadBalancerName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DetachElasticLoadBalancerResponse) 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=Dismount-OPSElasticLoadBalancer.html&tocid=Dismount-OPSElasticLoadBalancer</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSAgentVersion</name> <description> <para>Invokes the DescribeAgentVersions operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSAgentVersion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. <code>DescribeAgentVersions</code> returns a list of available agent versions for the specified stack or configuration manager. </para> </description> <syntax> <syntaxItem> <name>Get-OPSAgentVersion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Name</name> <description> <para>The name. This parameter must be set to "Chef". </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Version</name> <description> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Name</name> <description> <para>The name. This parameter must be set to "Chef". </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="False" position="Named"> <name>ConfigurationManager_Version</name> <description> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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.OpsWorks.Model.AgentVersion</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of AgentVersion objects. The service call response (type Amazon.OpsWorks.Model.DescribeAgentVersionsResponse) 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-OPSAgentVersion.html&tocid=Get-OPSAgentVersion</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSApp</name> <description> <para>Invokes the DescribeApps operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSApp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests a description of a specified set of apps. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The app stack ID. If you use this parameter, <code>DescribeApps</code> returns a description of the apps in the specified stack. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>AppId</name> <description> <para>An array of app IDs for the apps to be described. If you use this parameter, <code>DescribeApps</code> returns a description of the specified apps. Otherwise, it returns a description of every app. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>AppId</name> <description> <para>An array of app IDs for the apps to be described. If you use this parameter, <code>DescribeApps</code> returns a description of the specified apps. Otherwise, it returns a description of every app. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The app stack ID. If you use this parameter, <code>DescribeApps</code> returns a description of the apps in the specified stack. </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.OpsWorks.Model.App</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of App objects. The service call response (type Amazon.OpsWorks.Model.DescribeAppsResponse) 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-OPSApp.html&tocid=Get-OPSApp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSCommand</name> <description> <para>Invokes the DescribeCommands operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSCommand</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the results of specified commands. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSCommand</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>DeploymentId</name> <description> <para>The deployment ID. If you include this parameter, <code>DescribeCommands</code> returns a description of the commands associated with the specified deployment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>InstanceId</name> <description> <para>The instance ID. If you include this parameter, <code>DescribeCommands</code> returns a description of the commands associated with the specified instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>CommandId</name> <description> <para>An array of command IDs. If you include this parameter, <code>DescribeCommands</code> returns a description of the specified commands. Otherwise, it returns a description of every command. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>CommandId</name> <description> <para>An array of command IDs. If you include this parameter, <code>DescribeCommands</code> returns a description of the specified commands. Otherwise, it returns a description of every command. </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 (ByValue, ByPropertyName)" position="1"> <name>DeploymentId</name> <description> <para>The deployment ID. If you include this parameter, <code>DescribeCommands</code> returns a description of the commands associated with the specified deployment. </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="2"> <name>InstanceId</name> <description> <para>The instance ID. If you include this parameter, <code>DescribeCommands</code> returns a description of the commands associated with the specified instance. </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.OpsWorks.Model.Command</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Command objects. The service call response (type Amazon.OpsWorks.Model.DescribeCommandsResponse) 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-OPSCommand.html&tocid=Get-OPSCommand</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSDeployment</name> <description> <para>Invokes the DescribeDeployments operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSDeployment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests a description of a specified set of deployments. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSDeployment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. If you include this parameter, <code>DescribeDeployments</code> returns a description of the commands associated with the specified stack. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>AppId</name> <description> <para>The app ID. If you include this parameter, <code>DescribeDeployments</code> returns a description of the commands associated with the specified app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>DeploymentId</name> <description> <para>An array of deployment IDs to be described. If you include this parameter, <code>DescribeDeployments</code> returns a description of the specified deployments. Otherwise, it returns a description of every deployment. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>AppId</name> <description> <para>The app ID. If you include this parameter, <code>DescribeDeployments</code> returns a description of the commands associated with the specified app. </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="3"> <name>DeploymentId</name> <description> <para>An array of deployment IDs to be described. If you include this parameter, <code>DescribeDeployments</code> returns a description of the specified deployments. Otherwise, it returns a description of every deployment. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. If you include this parameter, <code>DescribeDeployments</code> returns a description of the commands associated with the specified stack. </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.OpsWorks.Model.Deployment</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Deployment objects. The service call response (type Amazon.OpsWorks.Model.DescribeDeploymentsResponse) 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-OPSDeployment.html&tocid=Get-OPSDeployment</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSEcsCluster</name> <description> <para>Invokes the DescribeEcsClusters operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSEcsCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and <code>NextToken</code> parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. This call accepts only one resource-identifying parameter. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-OPSEcsCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>A stack ID. <code>DescribeEcsClusters</code> returns a description of the cluster that is registered with the stack. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EcsClusterArn</name> <description> <para>A list of ARNs, one for each cluster to be described. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If the previous paginated request did not return all of the remaining results, the response object's<code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>DescribeEcsClusters</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EcsClusterArn</name> <description> <para>A list of ARNs, one for each cluster to be described. </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="False" position="Named"> <name>MaxResult</name> <description> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If the previous paginated request did not return all of the remaining results, the response object's<code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>DescribeEcsClusters</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>A stack ID. <code>DescribeEcsClusters</code> returns a description of the cluster that is registered with the stack. </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.OpsWorks.Model.EcsCluster</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of EcsCluster objects. The service call response (type Amazon.OpsWorks.Model.DescribeEcsClustersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-OPSEcsCluster.html&tocid=Get-OPSEcsCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSElasticIp</name> <description> <para>Invokes the DescribeElasticIps operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSElasticIp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP addresses</a>. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSElasticIp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the Elastic IP addresses associated with the specified instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Ip</name> <description> <para>An array of Elastic IP addresses to be described. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>StackId</name> <description> <para>A stack ID. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the Elastic IP addresses that are registered with the specified stack. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the Elastic IP addresses associated with the specified instance. </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="False" position="2"> <name>Ip</name> <description> <para>An array of Elastic IP addresses to be described. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address. </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>StackId</name> <description> <para>A stack ID. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the Elastic IP addresses that are registered with the specified stack. </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.OpsWorks.Model.ElasticIp</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ElasticIp objects. The service call response (type Amazon.OpsWorks.Model.DescribeElasticIpsResponse) 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-OPSElasticIp.html&tocid=Get-OPSElasticIp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSElasticLoadBalancer</name> <description> <para>Invokes the DescribeElasticLoadBalancers operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSElasticLoadBalancer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes a stack's Elastic Load Balancing instances. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSElasticLoadBalancer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>A stack ID. The action describes the stack's Elastic Load Balancing instances. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>LayerId</name> <description> <para>A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>LayerId</name> <description> <para>A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>A stack ID. The action describes the stack's Elastic Load Balancing instances. </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.OpsWorks.Model.ElasticLoadBalancer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ElasticLoadBalancer objects. The service call response (type Amazon.OpsWorks.Model.DescribeElasticLoadBalancersResponse) 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-OPSElasticLoadBalancer.html&tocid=Get-OPSElasticLoadBalancer</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSHostnameSuggestion</name> <description> <para>Invokes the GetHostnameSuggestion operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSHostnameSuggestion</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets a generated host name for the specified layer, based on the current host name theme. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSHostnameSuggestion</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>The layer ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>The layer ID. </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.OpsWorks.Model.GetHostnameSuggestionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.OpsWorks.Model.GetHostnameSuggestionResponse 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-OPSHostnameSuggestion.html&tocid=Get-OPSHostnameSuggestion</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSInstance</name> <description> <para>Invokes the DescribeInstances operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests a description of a set of instances. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>A stack ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified stack. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>LayerId</name> <description> <para>A layer ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified layer. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>InstanceId</name> <description> <para>An array of instance IDs to be described. If you use this parameter, <code>DescribeInstances</code> returns a description of the specified instances. Otherwise, it returns a description of every instance. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>InstanceId</name> <description> <para>An array of instance IDs to be described. If you use this parameter, <code>DescribeInstances</code> returns a description of the specified instances. Otherwise, it returns a description of every instance. </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="2"> <name>LayerId</name> <description> <para>A layer ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified layer. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>A stack ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified stack. </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.OpsWorks.Model.Instance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Instance objects. The service call response (type Amazon.OpsWorks.Model.DescribeInstancesResponse) 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-OPSInstance.html&tocid=Get-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSLayer</name> <description> <para>Invokes the DescribeLayers operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSLayer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests a description of one or more layers in a specified stack. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSLayer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>LayerId</name> <description> <para>An array of layer IDs that specify the layers to be described. If you omit this parameter, <code>DescribeLayers</code> returns a description of every layer in the specified stack. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>LayerId</name> <description> <para>An array of layer IDs that specify the layers to be described. If you omit this parameter, <code>DescribeLayers</code> returns a description of every layer in the specified stack. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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.OpsWorks.Model.Layer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Layer objects. The service call response (type Amazon.OpsWorks.Model.DescribeLayersResponse) 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-OPSLayer.html&tocid=Get-OPSLayer</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSLoadBasedAutoScaling</name> <description> <para>Invokes the DescribeLoadBasedAutoScaling operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSLoadBasedAutoScaling</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes load-based auto scaling configurations for specified layers. You must specify at least one of the parameters. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSLoadBasedAutoScaling</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>An array of layer IDs. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>An array of layer IDs. </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.OpsWorks.Model.LoadBasedAutoScalingConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of LoadBasedAutoScalingConfiguration objects. The service call response (type Amazon.OpsWorks.Model.DescribeLoadBasedAutoScalingResponse) 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-OPSLoadBasedAutoScaling.html&tocid=Get-OPSLoadBasedAutoScaling</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSMyUserProfile</name> <description> <para>Invokes the DescribeMyUserProfile operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSMyUserProfile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes a user's SSH information. <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSMyUserProfile</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.OpsWorks.Model.SelfUserProfile</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a SelfUserProfile object. The service call response (type Amazon.OpsWorks.Model.DescribeMyUserProfileResponse) 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-OPSMyUserProfile.html&tocid=Get-OPSMyUserProfile</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSPermission</name> <description> <para>Invokes the DescribePermissions operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSPermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the permissions for a specified stack. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSPermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>IamUserArn</name> <description> <para>The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>IamUserArn</name> <description> <para>The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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.OpsWorks.Model.Permission</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Permission objects. The service call response (type Amazon.OpsWorks.Model.DescribePermissionsResponse) 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-OPSPermission.html&tocid=Get-OPSPermission</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSRaidArray</name> <description> <para>Invokes the DescribeRaidArrays operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSRaidArray</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describe an instance's RAID arrays. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSRaidArray</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. If you use this parameter, <code>DescribeRaidArrays</code> returns descriptions of the RAID arrays associated with the specified instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>RaidArrayId</name> <description> <para>An array of RAID array IDs. If you use this parameter, <code>DescribeRaidArrays</code> returns descriptions of the specified arrays. Otherwise, it returns a description of every array. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. If you use this parameter, <code>DescribeRaidArrays</code> returns descriptions of the RAID arrays associated with the specified instance. </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="2"> <name>RaidArrayId</name> <description> <para>An array of RAID array IDs. If you use this parameter, <code>DescribeRaidArrays</code> returns descriptions of the specified arrays. Otherwise, it returns a description of every array. </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>StackId</name> <description> <para>The stack ID. </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.OpsWorks.Model.RaidArray</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RaidArray objects. The service call response (type Amazon.OpsWorks.Model.DescribeRaidArraysResponse) 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-OPSRaidArray.html&tocid=Get-OPSRaidArray</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSRdsDbInstance</name> <description> <para>Invokes the DescribeRdsDbInstances operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSRdsDbInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes Amazon RDS instances. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. This call accepts only one resource-identifying parameter. </para> </description> <syntax> <syntaxItem> <name>Get-OPSRdsDbInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RdsDbInstanceArn</name> <description> <para>An array containing the ARNs of the instances to be described. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RdsDbInstanceArn</name> <description> <para>An array containing the ARNs of the instances to be described. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances. </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.OpsWorks.Model.RdsDbInstance</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of RdsDbInstance objects. The service call response (type Amazon.OpsWorks.Model.DescribeRdsDbInstancesResponse) 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-OPSRdsDbInstance.html&tocid=Get-OPSRdsDbInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSResourceTag</name> <description> <para>Invokes the ListTags operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of tags that are applied to the specified stack or layer.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-OPSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The stack or layer's Amazon Resource Number (ARN). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Do not use. A validation exception occurs if you add a <code>MaxResults</code> parameter to a <code>ListTagsRequest</code> call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Do not use. A validation exception occurs if you add a <code>NextToken</code> parameter to a <code>ListTagsRequest</code> call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Do not use. A validation exception occurs if you add a <code>MaxResults</code> parameter to a <code>ListTagsRequest</code> call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Do not use. A validation exception occurs if you add a <code>NextToken</code> parameter to a <code>ListTagsRequest</code> call. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The stack or layer's Amazon Resource Number (ARN). </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of String objects. The service call response (type Amazon.OpsWorks.Model.ListTagsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-OPSResourceTag.html&tocid=Get-OPSResourceTag</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSServiceError</name> <description> <para>Invokes the DescribeServiceErrors operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSServiceError</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes AWS OpsWorks Stacks service errors. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. This call accepts only one resource-identifying parameter. </para> </description> <syntax> <syntaxItem> <name>Get-OPSServiceError</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the errors associated with the specified stack. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>InstanceId</name> <description> <para>The instance ID. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the errors associated with the specified instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>ServiceErrorId</name> <description> <para>An array of service error IDs. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the specified errors. Otherwise, it returns a description of every error. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>InstanceId</name> <description> <para>The instance ID. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the errors associated with the specified instance. </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="False" position="3"> <name>ServiceErrorId</name> <description> <para>An array of service error IDs. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the specified errors. Otherwise, it returns a description of every error. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the errors associated with the specified stack. </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.OpsWorks.Model.ServiceError</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ServiceError objects. The service call response (type Amazon.OpsWorks.Model.DescribeServiceErrorsResponse) 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-OPSServiceError.html&tocid=Get-OPSServiceError</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSStack</name> <description> <para>Invokes the DescribeStacks operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSStack</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests a description of one or more stacks. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSStack</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>An array of stack IDs that specify the stacks to be described. If you omit this parameter, <code>DescribeStacks</code> returns a description of every stack. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>An array of stack IDs that specify the stacks to be described. If you omit this parameter, <code>DescribeStacks</code> returns a description of every stack. </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.OpsWorks.Model.Stack</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Stack objects. The service call response (type Amazon.OpsWorks.Model.DescribeStacksResponse) 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-OPSStack.html&tocid=Get-OPSStack</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSStackProvisioningParameter</name> <description> <para>Invokes the DescribeStackProvisioningParameters operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSStackProvisioningParameter</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Requests a description of a stack's provisioning parameters. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSStackProvisioningParameter</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID </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.OpsWorks.Model.DescribeStackProvisioningParametersResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.OpsWorks.Model.DescribeStackProvisioningParametersResponse 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-OPSStackProvisioningParameter.html&tocid=Get-OPSStackProvisioningParameter</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSStackSummary</name> <description> <para>Invokes the DescribeStackSummary operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSStackSummary</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or <code>online</code>. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSStackSummary</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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.OpsWorks.Model.StackSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a StackSummary object. The service call response (type Amazon.OpsWorks.Model.DescribeStackSummaryResponse) 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-OPSStackSummary.html&tocid=Get-OPSStackSummary</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSTimeBasedAutoScaling</name> <description> <para>Invokes the DescribeTimeBasedAutoScaling operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSTimeBasedAutoScaling</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes time-based auto scaling configurations for specified instances. You must specify at least one of the parameters. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSTimeBasedAutoScaling</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>An array of instance IDs. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>An array of instance IDs. </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.OpsWorks.Model.TimeBasedAutoScalingConfiguration</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of TimeBasedAutoScalingConfiguration objects. The service call response (type Amazon.OpsWorks.Model.DescribeTimeBasedAutoScalingResponse) 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-OPSTimeBasedAutoScaling.html&tocid=Get-OPSTimeBasedAutoScaling</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSUserProfile</name> <description> <para>Invokes the DescribeUserProfiles operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSUserProfile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describe specified users. <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSUserProfile</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>IamUserArn</name> <description> <para>An array of IAM or federated user ARNs that identify the users to be described. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>IamUserArn</name> <description> <para>An array of IAM or federated user ARNs that identify the users to be described. </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.OpsWorks.Model.UserProfile</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of UserProfile objects. The service call response (type Amazon.OpsWorks.Model.DescribeUserProfilesResponse) 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-OPSUserProfile.html&tocid=Get-OPSUserProfile</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Get-OPSVolume</name> <description> <para>Invokes the DescribeVolumes operation against AWS OpsWorks.</para> </description> <verb>Get</verb> <noun>OPSVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes an instance's Amazon EBS volumes. This call accepts only one resource-identifying parameter. <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Get-OPSVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the volumes associated with the specified instance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>RaidArrayId</name> <description> <para>The RAID array ID. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the volumes associated with the specified RAID array. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>VolumeId</name> <description> <para>Am array of volume IDs. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the specified volumes. Otherwise, it returns a description of every volume. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>StackId</name> <description> <para>A stack ID. The action describes the stack's registered Amazon EBS volumes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the volumes associated with the specified instance. </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="2"> <name>RaidArrayId</name> <description> <para>The RAID array ID. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the volumes associated with the specified RAID array. </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>StackId</name> <description> <para>A stack ID. The action describes the stack's registered Amazon EBS volumes. </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="False" position="3"> <name>VolumeId</name> <description> <para>Am array of volume IDs. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the specified volumes. Otherwise, it returns a description of every volume. </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.OpsWorks.Model.Volume</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Volume objects. The service call response (type Amazon.OpsWorks.Model.DescribeVolumesResponse) 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-OPSVolume.html&tocid=Get-OPSVolume</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Grant-OPSAccess</name> <description> <para>Invokes the GrantAccess operation against AWS OpsWorks.</para> </description> <verb>Grant</verb> <noun>OPSAccess</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period. </para> </description> <syntax> <syntaxItem> <name>Grant-OPSAccess</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InstanceId</name> <description> <para>The instance's AWS OpsWorks Stacks ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ValidForInMinute</name> <description> <para>The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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>InstanceId</name> <description> <para>The instance's AWS OpsWorks Stacks ID. </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="False" position="Named"> <name>ValidForInMinute</name> <description> <para>The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.OpsWorks.Model.TemporaryCredential</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a TemporaryCredential object. The service call response (type Amazon.OpsWorks.Model.GrantAccessResponse) 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=Grant-OPSAccess.html&tocid=Grant-OPSAccess</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>New-OPSApp</name> <description> <para>Invokes the CreateApp operation against AWS OpsWorks.</para> </description> <verb>New</verb> <noun>OPSApp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an app for a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html">Creating Apps</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>New-OPSApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Name</name> <description> <para>The app name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Shortname</name> <description> <para>The app's short name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Description</name> <description> <para>A description of the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>Type</name> <description> <para>The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify <code>other</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.AppType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key/value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SslConfiguration_Certificate</name> <description> <para>The contents of the certificate's domain.crt file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SslConfiguration_Chain</name> <description> <para>Optional. Can be used to specify an intermediate certificate authority key or client authentication. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DataSource</name> <description> <para>The app's data source. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.DataSource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Domain</name> <description> <para>The app virtual host settings, with multiple domains separated by commas. For example: <code>'www.example.com, example.com'</code> </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableSsl</name> <description> <para>Whether to enable SSL for the app. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Environment</name> <description> <para>An array of <code>EnvironmentVariable</code> objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment"> Environment Variables</a>. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)." This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.EnvironmentVariable[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SslConfiguration_PrivateKey</name> <description> <para>The private key; the contents of the certificate's domain.kex file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>AppSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </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="False" position="Named"> <name>AppSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>AppSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> <type> <name>Amazon.OpsWorks.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </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="False" position="Named"> <name>AppSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </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="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key/value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DataSource</name> <description> <para>The app's data source. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.DataSource[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.DataSource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Description</name> <description> <para>A description of the app. </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="False" position="Named"> <name>Domain</name> <description> <para>The app virtual host settings, with multiple domains separated by commas. For example: <code>'www.example.com, example.com'</code> </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="False" position="Named"> <name>EnableSsl</name> <description> <para>Whether to enable SSL for the app. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Environment</name> <description> <para>An array of <code>EnvironmentVariable</code> objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment"> Environment Variables</a>. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)." This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.EnvironmentVariable[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.EnvironmentVariable[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="2"> <name>Name</name> <description> <para>The app name. </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="False" position="3"> <name>Shortname</name> <description> <para>The app's short name. </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="False" position="Named"> <name>SslConfiguration_Certificate</name> <description> <para>The contents of the certificate's domain.crt file. </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="False" position="Named"> <name>SslConfiguration_Chain</name> <description> <para>Optional. Can be used to specify an intermediate certificate authority key or client authentication. </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="False" position="Named"> <name>SslConfiguration_PrivateKey</name> <description> <para>The private key; the contents of the certificate's domain.kex file. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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="False" position="5"> <name>Type</name> <description> <para>The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify <code>other</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.AppType</parameterValue> <type> <name>Amazon.OpsWorks.AppType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.CreateAppResponse) 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=New-OPSApp.html&tocid=New-OPSApp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>New-OPSDeployment</name> <description> <para>Invokes the CreateDeployment operation against AWS OpsWorks.</para> </description> <verb>New</verb> <noun>OPSDeployment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Runs deployment or stack commands. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html">Deploying Apps</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html">Run Stack Commands</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>New-OPSDeployment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>AppId</name> <description> <para>The app ID. This parameter is required for app deployments, but not for other deployment commands. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <name>InstanceId</name> <description> <para>The instance IDs for the deployment targets. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Comment</name> <description> <para>A user-defined comment. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="5"> <name>CustomJson</name> <description> <para>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format: <code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code> For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Command_Arg</name> <description> <para>The arguments of those commands that take arguments. It should be set to a JSON object with the following format: <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> The <code>update_dependencies</code> command takes two arguments: - <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> argument to true. - <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either <code>true</code> or <code>false</code>. The default value is <code>false</code>. For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>LayerId</name> <description> <para>The layer IDs for the deployment targets. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Command_Name</name> <description> <para>Specifies the operation. You can specify only one command. For stacks, the following commands are available: - <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>. - <code>install_dependencies</code>: Install the stack's dependencies. - <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. - <code>update_dependencies</code>: Update the stack's dependencies. The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing. For apps, the following commands are available: - <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. - <code>rollback</code> Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions. - <code>start</code>: Start the app's web or application server. - <code>stop</code>: Stop the app's web or application server. - <code>restart</code>: Restart the app's web or application server. - <code>undeploy</code>: Undeploy the app. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.DeploymentCommandName</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>AppId</name> <description> <para>The app ID. This parameter is required for app deployments, but not for other deployment commands. </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="False" position="Named"> <name>Command_Arg</name> <description> <para>The arguments of those commands that take arguments. It should be set to a JSON object with the following format: <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> The <code>update_dependencies</code> command takes two arguments: - <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> argument to true. - <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either <code>true</code> or <code>false</code>. The default value is <code>false</code>. For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Command_Name</name> <description> <para>Specifies the operation. You can specify only one command. For stacks, the following commands are available: - <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>. - <code>install_dependencies</code>: Install the stack's dependencies. - <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. - <code>update_dependencies</code>: Update the stack's dependencies. The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing. For apps, the following commands are available: - <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. - <code>rollback</code> Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions. - <code>start</code>: Start the app's web or application server. - <code>stop</code>: Stop the app's web or application server. - <code>restart</code>: Restart the app's web or application server. - <code>undeploy</code>: Undeploy the app. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.DeploymentCommandName</parameterValue> <type> <name>Amazon.OpsWorks.DeploymentCommandName</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>Comment</name> <description> <para>A user-defined comment. </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="False" position="5"> <name>CustomJson</name> <description> <para>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format: <code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code> For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>. </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="False" 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="3"> <name>InstanceId</name> <description> <para>The instance IDs for the deployment targets. </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>LayerId</name> <description> <para>The layer IDs for the deployment targets. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.CreateDeploymentResponse) 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=New-OPSDeployment.html&tocid=New-OPSDeployment</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>New-OPSInstance</name> <description> <para>Invokes the CreateInstance operation against AWS OpsWorks.</para> </description> <verb>New</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an instance in a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html">Adding an Instance to a Layer</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>New-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>LayerId</name> <description> <para>An array that contains the instance's layer IDs. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>InstanceType</name> <description> <para>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - <code>INHERIT</code> - Use the stack's default agent version setting. - <i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance. The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AmiId</name> <description> <para>A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. If you specify a custom AMI, you must set <code>Os</code> to <code>Custom</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Architecture</name> <description> <para>The instance architecture. The default option is <code>x86_64</code>. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Architecture</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingType</name> <description> <para>For load-based or time-based instances, the type. Windows stacks can use only time-based instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.AutoScalingType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The instance Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BlockDeviceMapping</name> <description> <para>An array of <code>BlockDeviceMapping</code> objects that specify the instance's block devices. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a>. Note that block device mappings are not supported for custom AMIs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.BlockDeviceMapping[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EbsOptimized</name> <description> <para>Whether to create an Amazon EBS-optimized instance. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hostname</name> <description> <para>The instance host name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstallUpdatesOnBoot</name> <description> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. We strongly recommend using the default value of <code>true</code> to ensure that your instances have the latest security updates. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Os</name> <description> <para>The instance's operating system, which must be set to one of the following. - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. - A custom AMI: <code>Custom</code>. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <a>CreateInstance</a> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>For more information on how to use custom AMIs with AWS OpsWorks Stacks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RootDeviceType</name> <description> <para>The instance root device type. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.RootDeviceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SshKeyName</name> <description> <para>The instance's Amazon EC2 key-pair name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SubnetId</name> <description> <para>The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tenancy</name> <description> <para>The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: <code>dedicated</code>, <code>default</code>, or <code>host</code>. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Dedicated Hosts Overview</a> and <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Amazon EC2 Dedicated Hosts</a>. For more information about dedicated instances, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html">Dedicated Instances</a> and <a href="http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/">Amazon EC2 Dedicated Instances</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VirtualizationType</name> <description> <para>The instance's virtualization type, <code>paravirtual</code> or <code>hvm</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.VirtualizationType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - <code>INHERIT</code> - Use the stack's default agent version setting. - <i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance. The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. </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="False" position="Named"> <name>AmiId</name> <description> <para>A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. If you specify a custom AMI, you must set <code>Os</code> to <code>Custom</code>. </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="False" position="Named"> <name>Architecture</name> <description> <para>The instance architecture. The default option is <code>x86_64</code>. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Architecture</parameterValue> <type> <name>Amazon.OpsWorks.Architecture</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingType</name> <description> <para>For load-based or time-based instances, the type. Windows stacks can use only time-based instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.AutoScalingType</parameterValue> <type> <name>Amazon.OpsWorks.AutoScalingType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AvailabilityZone</name> <description> <para>The instance Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. </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="False" position="Named"> <name>BlockDeviceMapping</name> <description> <para>An array of <code>BlockDeviceMapping</code> objects that specify the instance's block devices. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a>. Note that block device mappings are not supported for custom AMIs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.BlockDeviceMapping[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.BlockDeviceMapping[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EbsOptimized</name> <description> <para>Whether to create an Amazon EBS-optimized instance. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Hostname</name> <description> <para>The instance host name. </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="False" position="Named"> <name>InstallUpdatesOnBoot</name> <description> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. We strongly recommend using the default value of <code>true</code> to ensure that your instances have the latest security updates. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>InstanceType</name> <description> <para>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table. </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="2"> <name>LayerId</name> <description> <para>An array that contains the instance's layer IDs. </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="False" position="Named"> <name>Os</name> <description> <para>The instance's operating system, which must be set to one of the following. - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. - A custom AMI: <code>Custom</code>. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <a>CreateInstance</a> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>For more information on how to use custom AMIs with AWS OpsWorks Stacks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. </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="False" position="Named"> <name>RootDeviceType</name> <description> <para>The instance root device type. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.RootDeviceType</parameterValue> <type> <name>Amazon.OpsWorks.RootDeviceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SshKeyName</name> <description> <para>The instance's Amazon EC2 key-pair name. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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="False" position="Named"> <name>SubnetId</name> <description> <para>The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet. </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="False" position="Named"> <name>Tenancy</name> <description> <para>The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: <code>dedicated</code>, <code>default</code>, or <code>host</code>. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Dedicated Hosts Overview</a> and <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Amazon EC2 Dedicated Hosts</a>. For more information about dedicated instances, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html">Dedicated Instances</a> and <a href="http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/">Amazon EC2 Dedicated Instances</a>. </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="False" position="Named"> <name>VirtualizationType</name> <description> <para>The instance's virtualization type, <code>paravirtual</code> or <code>hvm</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.VirtualizationType</parameterValue> <type> <name>Amazon.OpsWorks.VirtualizationType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.CreateInstanceResponse) 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=New-OPSInstance.html&tocid=New-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>New-OPSLayer</name> <description> <para>Invokes the CreateLayer operation against AWS OpsWorks.</para> </description> <verb>New</verb> <noun>OPSLayer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html">How to Create a Layer</a>. You should use <b>CreateLayer</b> for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, <b>CreateLayer</b> fails. A stack can have an arbitrary number of custom layers, so you can call <b>CreateLayer</b> as many times as you like for that layer type. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>New-OPSLayer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The layer stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Type</name> <description> <para>The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.LayerType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Name</name> <description> <para>The layer name, which is used by the console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the <code>EcsClusterArn</code> attribute to the cluster's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoAssignElasticIp</name> <description> <para>Whether to automatically assign an <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoAssignPublicIp</name> <description> <para>For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Configure</name> <description> <para>An array of custom recipe names to be run following a <code>configure</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomInstanceProfileArn</name> <description> <para>The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomJson</name> <description> <para>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>. This feature is supported as of version 1.7.42 of the AWS CLI. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomSecurityGroupId</name> <description> <para>An array containing the layer custom security group IDs. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Shutdown_DelayUntilElbConnectionsDrained</name> <description> <para>Whether to enable Elastic Load Balancing connection draining. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Deploy</name> <description> <para>An array of custom recipe names to be run following a <code>deploy</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableAutoHealing</name> <description> <para>Whether to disable auto healing for the layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsConfiguration_Enabled</name> <description> <para>Whether CloudWatch Logs is enabled for a layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Shutdown_ExecutionTimeout</name> <description> <para>The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstallUpdatesOnBoot</name> <description> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. To ensure that your instances have the latest security updates, we strongly recommend using the default value of <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsConfiguration_LogStream</name> <description> <para>A list of configuration options for CloudWatch Logs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.CloudWatchLogsLogStream[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Package</name> <description> <para>An array of <code>Package</code> objects that describes the layer packages. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Setup</name> <description> <para>An array of custom recipe names to be run following a <code>setup</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Shortname</name> <description> <para>For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer Reference</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Shutdown</name> <description> <para>An array of custom recipe names to be run following a <code>shutdown</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Undeploy</name> <description> <para>An array of custom recipe names to be run following a <code>undeploy</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseEbsOptimizedInstance</name> <description> <para>Whether to use Amazon EBS-optimized instances. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VolumeConfiguration</name> <description> <para>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.VolumeConfiguration[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the <code>EcsClusterArn</code> attribute to the cluster's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoAssignElasticIp</name> <description> <para>Whether to automatically assign an <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoAssignPublicIp</name> <description> <para>For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsConfiguration_Enabled</name> <description> <para>Whether CloudWatch Logs is enabled for a layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsConfiguration_LogStream</name> <description> <para>A list of configuration options for CloudWatch Logs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.CloudWatchLogsLogStream[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.CloudWatchLogsLogStream[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomInstanceProfileArn</name> <description> <para>The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </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="False" position="Named"> <name>CustomJson</name> <description> <para>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>. This feature is supported as of version 1.7.42 of the AWS CLI. </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="False" position="Named"> <name>CustomRecipes_Configure</name> <description> <para>An array of custom recipe names to be run following a <code>configure</code> event. </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="False" position="Named"> <name>CustomRecipes_Deploy</name> <description> <para>An array of custom recipe names to be run following a <code>deploy</code> event. </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="False" position="Named"> <name>CustomRecipes_Setup</name> <description> <para>An array of custom recipe names to be run following a <code>setup</code> event. </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="False" position="Named"> <name>CustomRecipes_Shutdown</name> <description> <para>An array of custom recipe names to be run following a <code>shutdown</code> event. </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="False" position="Named"> <name>CustomRecipes_Undeploy</name> <description> <para>An array of custom recipe names to be run following a <code>undeploy</code> event. </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="False" position="Named"> <name>CustomSecurityGroupId</name> <description> <para>An array containing the layer custom security group IDs. </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="False" position="Named"> <name>EnableAutoHealing</name> <description> <para>Whether to disable auto healing for the layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>InstallUpdatesOnBoot</name> <description> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. To ensure that your instances have the latest security updates, we strongly recommend using the default value of <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>Name</name> <description> <para>The layer name, which is used by the console. </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="False" position="Named"> <name>Package</name> <description> <para>An array of <code>Package</code> objects that describes the layer packages. </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="False" position="Named"> <name>Shortname</name> <description> <para>For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer Reference</a>. </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="False" position="Named"> <name>Shutdown_DelayUntilElbConnectionsDrained</name> <description> <para>Whether to enable Elastic Load Balancing connection draining. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Shutdown_ExecutionTimeout</name> <description> <para>The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The layer stack ID. </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="False" position="2"> <name>Type</name> <description> <para>The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.LayerType</parameterValue> <type> <name>Amazon.OpsWorks.LayerType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseEbsOptimizedInstance</name> <description> <para>Whether to use Amazon EBS-optimized instances. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VolumeConfiguration</name> <description> <para>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.VolumeConfiguration[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.VolumeConfiguration[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.CreateLayerResponse) 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=New-OPSLayer.html&tocid=New-OPSLayer</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>New-OPSStack</name> <description> <para>Invokes the CreateStack operation against AWS OpsWorks.</para> </description> <verb>New</verb> <noun>OPSStack</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html">Create a New Stack</a>. <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>New-OPSStack</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Name</name> <description> <para>The stack name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>StackRegion</name> <description> <para>The stack's AWS region, such as "ap-south-1". For more information about Amazon regions, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key-value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_BerkshelfVersion</name> <description> <para>The Berkshelf version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomJson</name> <description> <para>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: <code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code> For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultAvailabilityZone</name> <description> <para>The stack's default Availability Zone, which must be in the specified region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see the <code>VpcId</code> parameter description. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultInstanceProfileArn</name> <description> <para>The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultOs</name> <description> <para>The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following. - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. - A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html"> Using Custom AMIs</a>. The default option is the current Amazon Linux version. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultRootDeviceType</name> <description> <para>The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is <code>instance-store</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.RootDeviceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSshKeyName</name> <description> <para>A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSubnetId</name> <description> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostnameTheme</name> <description> <para>The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are: - <code>Baked_Goods</code> - <code>Clouds</code> - <code>Europe_Cities</code> - <code>Fruits</code> - <code>Greek_Deities</code> - <code>Legendary_creatures_from_Japan</code> - <code>Planets_and_Moons</code> - <code>Roman_Deities</code> - <code>Scottish_Islands</code> - <code>US_Cities</code> - <code>Wild_Cats</code> To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_ManageBerkshelf</name> <description> <para>Whether to enable Berkshelf. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Name</name> <description> <para>The name. This parameter must be set to "Chef". </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseCustomCookbook</name> <description> <para>Whether the stack uses custom cookbooks. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseOpsworksSecurityGroup</name> <description> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With <code>UseOpsworksSecurityGroups</code> you can instead provide your own custom security groups. <code>UseOpsworksSecurityGroups</code> has the following settings: - True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. - False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Version</name> <description> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcId</name> <description> <para>The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later. - If your account supports EC2-Classic, the default value is <code>no VPC</code>. - If your account does not support EC2-Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: - It must belong to a VPC in your account that is in the specified region. - You must specify a value for <code>DefaultSubnetId</code>. For more information on how to use AWS OpsWorks Stacks with a VPC, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html">Running a Stack in a VPC</a>. For more information on default VPC and EC2-Classic, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. </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="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key-value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_BerkshelfVersion</name> <description> <para>The Berkshelf version. </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="False" position="Named"> <name>ChefConfiguration_ManageBerkshelf</name> <description> <para>Whether to enable Berkshelf. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Name</name> <description> <para>The name. This parameter must be set to "Chef". </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="False" position="Named"> <name>ConfigurationManager_Version</name> <description> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. </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="False" position="Named"> <name>CustomCookbooksSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>CustomCookbooksSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </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="False" position="Named"> <name>CustomCookbooksSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>CustomCookbooksSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> <type> <name>Amazon.OpsWorks.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </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="False" position="Named"> <name>CustomCookbooksSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </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="False" position="Named"> <name>CustomJson</name> <description> <para>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: <code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code> For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>. </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="False" position="Named"> <name>DefaultAvailabilityZone</name> <description> <para>The stack's default Availability Zone, which must be in the specified region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see the <code>VpcId</code> parameter description. </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="False" position="Named"> <name>DefaultInstanceProfileArn</name> <description> <para>The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </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="False" position="Named"> <name>DefaultOs</name> <description> <para>The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following. - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. - A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html"> Using Custom AMIs</a>. The default option is the current Amazon Linux version. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. </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="False" position="Named"> <name>DefaultRootDeviceType</name> <description> <para>The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is <code>instance-store</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.RootDeviceType</parameterValue> <type> <name>Amazon.OpsWorks.RootDeviceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSshKeyName</name> <description> <para>A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </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="False" position="Named"> <name>DefaultSubnetId</name> <description> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </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="False" 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="False" position="Named"> <name>HostnameTheme</name> <description> <para>The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are: - <code>Baked_Goods</code> - <code>Clouds</code> - <code>Europe_Cities</code> - <code>Fruits</code> - <code>Greek_Deities</code> - <code>Legendary_creatures_from_Japan</code> - <code>Planets_and_Moons</code> - <code>Roman_Deities</code> - <code>Scottish_Islands</code> - <code>US_Cities</code> - <code>Wild_Cats</code> To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme. </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 (ByValue, )" position="1"> <name>Name</name> <description> <para>The stack name. </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="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </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="False" position="2"> <name>StackRegion</name> <description> <para>The stack's AWS region, such as "ap-south-1". For more information about Amazon regions, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. </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="False" position="Named"> <name>UseCustomCookbook</name> <description> <para>Whether the stack uses custom cookbooks. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseOpsworksSecurityGroup</name> <description> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With <code>UseOpsworksSecurityGroups</code> you can instead provide your own custom security groups. <code>UseOpsworksSecurityGroups</code> has the following settings: - True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. - False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VpcId</name> <description> <para>The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later. - If your account supports EC2-Classic, the default value is <code>no VPC</code>. - If your account does not support EC2-Classic, the default value is the default VPC for the specified region. If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. If you specify a nondefault VPC ID, note the following: - It must belong to a VPC in your account that is in the specified region. - You must specify a value for <code>DefaultSubnetId</code>. For more information on how to use AWS OpsWorks Stacks with a VPC, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html">Running a Stack in a VPC</a>. For more information on default VPC and EC2-Classic, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.CreateStackResponse) 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=New-OPSStack.html&tocid=New-OPSStack</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>New-OPSUserProfile</name> <description> <para>Invokes the CreateUserProfile operation against AWS OpsWorks.</para> </description> <verb>New</verb> <noun>OPSUserProfile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a new user profile. <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>New-OPSUserProfile</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>IamUserArn</name> <description> <para>The user's IAM ARN; this can also be a federated user's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>SshUsername</name> <description> <para>The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, <code>my.name</code> will be changed to <code>myname</code>. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>SshPublicKey</name> <description> <para>The user's public SSH key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowSelfManagement</name> <description> <para>Whether users can specify their own SSH public key through the My Settings page. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html">Setting an IAM User's Public SSH Key</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowSelfManagement</name> <description> <para>Whether users can specify their own SSH public key through the My Settings page. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html">Setting an IAM User's Public SSH Key</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>IamUserArn</name> <description> <para>The user's IAM ARN; this can also be a federated user's ARN. </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="False" position="3"> <name>SshPublicKey</name> <description> <para>The user's public SSH key. </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="False" position="2"> <name>SshUsername</name> <description> <para>The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, <code>my.name</code> will be changed to <code>myname</code>. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.CreateUserProfileResponse) 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=New-OPSUserProfile.html&tocid=New-OPSUserProfile</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Register-OPSEcsCluster</name> <description> <para>Invokes the RegisterEcsCluster operation against AWS OpsWorks.</para> </description> <verb>Register</verb> <noun>OPSEcsCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html"> Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"> Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Register-OPSEcsCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EcsClusterArn</name> <description> <para>The cluster's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EcsClusterArn</name> <description> <para>The cluster's ARN. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.RegisterEcsClusterResponse) 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=Register-OPSEcsCluster.html&tocid=Register-OPSEcsCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Register-OPSElasticIp</name> <description> <para>Invokes the RegisterElasticIp operation against AWS OpsWorks.</para> </description> <verb>Register</verb> <noun>OPSElasticIp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling <a>DeregisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Register-OPSElasticIp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The Elastic IP address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The Elastic IP address. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.RegisterElasticIpResponse) 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=Register-OPSElasticIp.html&tocid=Register-OPSElasticIp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Register-OPSInstance</name> <description> <para>Invokes the RegisterInstance operation against AWS OpsWorks.</para> </description> <verb>Register</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack. We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. <code>RegisterInstance</code> handles only the second step. You should instead use the AWS CLI <code>register</code> command, which performs the entire registration operation. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html"> Registering an Instance with an AWS OpsWorks Stacks Stack</a>. Registered instances have the same requirements as instances that are created by using the <a>CreateInstance</a> API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering-preparer.html"> Preparing the Instance</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Register-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The ID of the stack that the instance is to be registered with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstanceIdentity_Document</name> <description> <para>A JSON document that contains the metadata. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hostname</name> <description> <para>The instance's hostname. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PrivateIp</name> <description> <para>The instance's private IP address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PublicIp</name> <description> <para>The instance's public IP address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RsaPublicKey</name> <description> <para>The instances public RSA key. This key is used to encrypt communication between the instance and the service. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RsaPublicKeyFingerprint</name> <description> <para>The instances public RSA key fingerprint. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstanceIdentity_Signature</name> <description> <para>A signature that can be used to verify the document's accuracy and authenticity. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Hostname</name> <description> <para>The instance's hostname. </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="False" position="Named"> <name>InstanceIdentity_Document</name> <description> <para>A JSON document that contains the metadata. </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="False" position="Named"> <name>InstanceIdentity_Signature</name> <description> <para>A signature that can be used to verify the document's accuracy and authenticity. </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="False" position="Named"> <name>PrivateIp</name> <description> <para>The instance's private IP address. </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="False" position="Named"> <name>PublicIp</name> <description> <para>The instance's public IP address. </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="False" position="Named"> <name>RsaPublicKey</name> <description> <para>The instances public RSA key. This key is used to encrypt communication between the instance and the service. </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="False" position="Named"> <name>RsaPublicKeyFingerprint</name> <description> <para>The instances public RSA key fingerprint. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The ID of the stack that the instance is to be registered with. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.RegisterInstanceResponse) 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=Register-OPSInstance.html&tocid=Register-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Register-OPSInstanceAssignment</name> <description> <para>Invokes the AssignInstance operation against AWS OpsWorks.</para> </description> <verb>Register</verb> <noun>OPSInstanceAssignment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Assign a registered instance to a layer. - You can assign registered on-premises instances to any layer type. - You can assign registered Amazon EC2 instances only to custom layers. - You cannot use this action with instances that were created with AWS OpsWorks Stacks. <b>Required Permissions</b>: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Register-OPSInstanceAssignment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>LayerId</name> <description> <para>The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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>LayerId</name> <description> <para>The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.AssignInstanceResponse) 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=Register-OPSInstanceAssignment.html&tocid=Register-OPSInstanceAssignment</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Register-OPSRdsDbInstance</name> <description> <para>Invokes the RegisterRdsDbInstance operation against AWS OpsWorks.</para> </description> <verb>Register</verb> <noun>OPSRdsDbInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers an Amazon RDS instance with a stack. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Register-OPSRdsDbInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>RdsDbInstanceArn</name> <description> <para>The Amazon RDS instance's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbPassword</name> <description> <para>The database password. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbUser</name> <description> <para>The database's master user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbPassword</name> <description> <para>The database password. </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="False" position="Named"> <name>DbUser</name> <description> <para>The database's master user name. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </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="False" position="2"> <name>RdsDbInstanceArn</name> <description> <para>The Amazon RDS instance's ARN. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the StackId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.RegisterRdsDbInstanceResponse) 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=Register-OPSRdsDbInstance.html&tocid=Register-OPSRdsDbInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Register-OPSVolume</name> <description> <para>Invokes the RegisterVolume operation against AWS OpsWorks.</para> </description> <verb>Register</verb> <noun>OPSVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling <a>DeregisterVolume</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Register-OPSVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Ec2VolumeId</name> <description> <para>The Amazon EBS volume ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Ec2VolumeId</name> <description> <para>The Amazon EBS volume ID. </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="False" 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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorks.Model.RegisterVolumeResponse) 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=Register-OPSVolume.html&tocid=Register-OPSVolume</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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-OPSApp</name> <description> <para>Invokes the DeleteApp operation against AWS OpsWorks.</para> </description> <verb>Remove</verb> <noun>OPSApp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a specified app. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-OPSApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AppId</name> <description> <para>The app ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AppId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AppId</name> <description> <para>The app ID. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AppId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AppId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeleteAppResponse) 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-OPSApp.html&tocid=Remove-OPSApp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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-OPSElasticIp</name> <description> <para>Invokes the DisassociateElasticIp operation against AWS OpsWorks.</para> </description> <verb>Remove</verb> <noun>OPSElasticIp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-OPSElasticIp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ElasticIp</name> <description> <para>The Elastic IP address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ElasticIp parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ElasticIp</name> <description> <para>The Elastic IP address. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ElasticIp parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ElasticIp parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DisassociateElasticIpResponse) 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-OPSElasticIp.html&tocid=Remove-OPSElasticIp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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-OPSInstance</name> <description> <para>Invokes the DeleteInstance operation against AWS OpsWorks.</para> </description> <verb>Remove</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html">Deleting Instances</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DeleteElasticIp</name> <description> <para>Whether to delete the instance Elastic IP address. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DeleteVolume</name> <description> <para>Whether to delete the instance's Amazon EBS volumes. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>DeleteElasticIp</name> <description> <para>Whether to delete the instance Elastic IP address. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>DeleteVolume</name> <description> <para>Whether to delete the instance's Amazon EBS volumes. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeleteInstanceResponse) 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-OPSInstance.html&tocid=Remove-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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-OPSLayer</name> <description> <para>Invokes the DeleteLayer operation against AWS OpsWorks.</para> </description> <verb>Remove</verb> <noun>OPSLayer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html">How to Delete a Layer</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-OPSLayer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>The layer ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>The layer ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the LayerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeleteLayerResponse) 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-OPSLayer.html&tocid=Remove-OPSLayer</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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-OPSResourceTag</name> <description> <para>Invokes the UntagResource operation against AWS OpsWorks.</para> </description> <verb>Remove</verb> <noun>OPSResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Removes tags from a specified stack or layer. </para> </description> <syntax> <syntaxItem> <name>Remove-OPSResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The stack or layer's Amazon Resource Number (ARN). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TagKey</name> <description> <para>A list of the keys of tags to be removed from a stack or layer. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ResourceArn</name> <description> <para>The stack or layer's Amazon Resource Number (ARN). </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="False" position="Named"> <name>TagKey</name> <description> <para>A list of the keys of tags to be removed from a stack or layer. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ResourceArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UntagResourceResponse) 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-OPSResourceTag.html&tocid=Remove-OPSResourceTag</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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-OPSStack</name> <description> <para>Invokes the DeleteStack operation against AWS OpsWorks.</para> </description> <verb>Remove</verb> <noun>OPSStack</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html">Shut Down a Stack</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-OPSStack</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the StackId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeleteStackResponse) 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-OPSStack.html&tocid=Remove-OPSStack</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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-OPSUserProfile</name> <description> <para>Invokes the DeleteUserProfile operation against AWS OpsWorks.</para> </description> <verb>Remove</verb> <noun>OPSUserProfile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a user profile. <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-OPSUserProfile</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>IamUserArn</name> <description> <para>The user's IAM ARN. This can also be a federated user's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the IamUserArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>IamUserArn</name> <description> <para>The user's IAM ARN. This can also be a federated user's ARN. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the IamUserArn parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the IamUserArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeleteUserProfileResponse) 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-OPSUserProfile.html&tocid=Remove-OPSUserProfile</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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-OPSVolume</name> <description> <para>Invokes the UnassignVolume operation against AWS OpsWorks.</para> </description> <verb>Remove</verb> <noun>OPSVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Remove-OPSVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>VolumeId</name> <description> <para>The volume ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>VolumeId</name> <description> <para>The volume ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the VolumeId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UnassignVolumeResponse) 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-OPSVolume.html&tocid=Remove-OPSVolume</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Restart-OPSInstance</name> <description> <para>Invokes the RebootInstance operation against AWS OpsWorks.</para> </description> <verb>Restart</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Reboots a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Restart-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.RebootInstanceResponse) 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=Restart-OPSInstance.html&tocid=Restart-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Set-OPSLoadBasedAutoScaling</name> <description> <para>Invokes the SetLoadBasedAutoScaling operation against AWS OpsWorks.</para> </description> <verb>Set</verb> <noun>OPSLoadBasedAutoScaling</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Specify the load-based auto scaling configuration for a specified layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Set-OPSLoadBasedAutoScaling</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>The layer ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Enable</name> <description> <para>Enables load-based auto scaling for the layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_Alarm</name> <description> <para>Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. To use custom alarms, you must update your service role to allow <code>cloudwatch:DescribeAlarms</code>. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html">Allowing AWS OpsWorks Stacks to Act on Your Behalf</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_Alarm</name> <description> <para>Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. To use custom alarms, you must update your service role to allow <code>cloudwatch:DescribeAlarms</code>. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html">Allowing AWS OpsWorks Stacks to Act on Your Behalf</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_CpuThreshold</name> <description> <para>The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_CpuThreshold</name> <description> <para>The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_IgnoreMetricsTime</name> <description> <para>The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. <code>IgnoreMetricsTime</code> allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_IgnoreMetricsTime</name> <description> <para>The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. <code>IgnoreMetricsTime</code> allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_InstanceCount</name> <description> <para>The number of instances to add or remove when the load exceeds a threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_InstanceCount</name> <description> <para>The number of instances to add or remove when the load exceeds a threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_LoadThreshold</name> <description> <para>The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see <a href="http://en.wikipedia.org/wiki/Load_%28computing%29">Load (computing)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_LoadThreshold</name> <description> <para>The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see <a href="http://en.wikipedia.org/wiki/Load_%28computing%29">Load (computing)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_MemoryThreshold</name> <description> <para>The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_MemoryThreshold</name> <description> <para>The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_ThresholdsWaitTime</name> <description> <para>The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_ThresholdsWaitTime</name> <description> <para>The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_Alarm</name> <description> <para>Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. To use custom alarms, you must update your service role to allow <code>cloudwatch:DescribeAlarms</code>. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html">Allowing AWS OpsWorks Stacks to Act on Your Behalf</a>. </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="False" position="Named"> <name>DownScaling_CpuThreshold</name> <description> <para>The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_IgnoreMetricsTime</name> <description> <para>The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. <code>IgnoreMetricsTime</code> allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_InstanceCount</name> <description> <para>The number of instances to add or remove when the load exceeds a threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_LoadThreshold</name> <description> <para>The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see <a href="http://en.wikipedia.org/wiki/Load_%28computing%29">Load (computing)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_MemoryThreshold</name> <description> <para>The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DownScaling_ThresholdsWaitTime</name> <description> <para>The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="2"> <name>Enable</name> <description> <para>Enables load-based auto scaling for the layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>The layer ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>UpScaling_Alarm</name> <description> <para>Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack. To use custom alarms, you must update your service role to allow <code>cloudwatch:DescribeAlarms</code>. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html">Allowing AWS OpsWorks Stacks to Act on Your Behalf</a>. </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="False" position="Named"> <name>UpScaling_CpuThreshold</name> <description> <para>The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_IgnoreMetricsTime</name> <description> <para>The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. <code>IgnoreMetricsTime</code> allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_InstanceCount</name> <description> <para>The number of instances to add or remove when the load exceeds a threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_LoadThreshold</name> <description> <para>The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see <a href="http://en.wikipedia.org/wiki/Load_%28computing%29">Load (computing)</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_MemoryThreshold</name> <description> <para>The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold. </para> </description> <parameterValue required="true" variableLength="false">System.Double</parameterValue> <type> <name>System.Double</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpScaling_ThresholdsWaitTime</name> <description> <para>The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the LayerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.SetLoadBasedAutoScalingResponse) 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=Set-OPSLoadBasedAutoScaling.html&tocid=Set-OPSLoadBasedAutoScaling</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Set-OPSPermission</name> <description> <para>Invokes the SetPermission operation against AWS OpsWorks.</para> </description> <verb>Set</verb> <noun>OPSPermission</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Specifies a user's permissions. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html">Security and Permissions</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Set-OPSPermission</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <name>IamUserArn</name> <description> <para>The user's IAM ARN. This can also be a federated user's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AllowSsh</name> <description> <para>The user is allowed to use SSH to communicate with the instance. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>AllowSudo</name> <description> <para>The user is allowed to use <b>sudo</b> to elevate privileges. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Level</name> <description> <para>The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level. - <code>deny</code> - <code>show</code> - <code>deploy</code> - <code>manage</code> - <code>iam_only</code> For more information on the permissions associated with these levels, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="3"> <name>AllowSsh</name> <description> <para>The user is allowed to use SSH to communicate with the instance. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="4"> <name>AllowSudo</name> <description> <para>The user is allowed to use <b>sudo</b> to elevate privileges. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="2"> <name>IamUserArn</name> <description> <para>The user's IAM ARN. This can also be a federated user's ARN. </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="False" position="Named"> <name>Level</name> <description> <para>The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level. - <code>deny</code> - <code>show</code> - <code>deploy</code> - <code>manage</code> - <code>iam_only</code> For more information on the permissions associated with these levels, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the StackId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.SetPermissionResponse) 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=Set-OPSPermission.html&tocid=Set-OPSPermission</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Set-OPSTimeBasedAutoScaling</name> <description> <para>Invokes the SetTimeBasedAutoScaling operation against AWS OpsWorks.</para> </description> <verb>Set</verb> <noun>OPSTimeBasedAutoScaling</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Specify the time-based auto scaling configuration for a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Set-OPSTimeBasedAutoScaling</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Friday</name> <description> <para>The schedule for Friday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Monday</name> <description> <para>The schedule for Monday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Saturday</name> <description> <para>The schedule for Saturday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Sunday</name> <description> <para>The schedule for Sunday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Thursday</name> <description> <para>The schedule for Thursday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Tuesday</name> <description> <para>The schedule for Tuesday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Wednesday</name> <description> <para>The schedule for Wednesday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Friday</name> <description> <para>The schedule for Friday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Monday</name> <description> <para>The schedule for Monday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Saturday</name> <description> <para>The schedule for Saturday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Sunday</name> <description> <para>The schedule for Sunday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Thursday</name> <description> <para>The schedule for Thursday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Tuesday</name> <description> <para>The schedule for Tuesday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingSchedule_Wednesday</name> <description> <para>The schedule for Wednesday. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.SetTimeBasedAutoScalingResponse) 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=Set-OPSTimeBasedAutoScaling.html&tocid=Set-OPSTimeBasedAutoScaling</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Start-OPSInstance</name> <description> <para>Invokes the StartInstance operation against AWS OpsWorks.</para> </description> <verb>Start</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Starts a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Start-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.StartInstanceResponse) 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=Start-OPSInstance.html&tocid=Start-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Start-OPSStack</name> <description> <para>Invokes the StartStack operation against AWS OpsWorks.</para> </description> <verb>Start</verb> <noun>OPSStack</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Starts a stack's instances. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Start-OPSStack</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the StackId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.StartStackResponse) 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=Start-OPSStack.html&tocid=Start-OPSStack</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Stop-OPSInstance</name> <description> <para>Invokes the StopInstance operation against AWS OpsWorks.</para> </description> <verb>Stop</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Stop-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.StopInstanceResponse) 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=Stop-OPSInstance.html&tocid=Stop-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Stop-OPSStack</name> <description> <para>Invokes the StopStack operation against AWS OpsWorks.</para> </description> <verb>Stop</verb> <noun>OPSStack</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Stops a specified stack. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Stop-OPSStack</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the StackId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.StopStackResponse) 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=Stop-OPSStack.html&tocid=Stop-OPSStack</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Unregister-OPSEcsCluster</name> <description> <para>Invokes the DeregisterEcsCluster operation against AWS OpsWorks.</para> </description> <verb>Unregister</verb> <noun>OPSEcsCluster</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deregisters a specified Amazon ECS cluster from a stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete"> Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html</a>. </para> </description> <syntax> <syntaxItem> <name>Unregister-OPSEcsCluster</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>EcsClusterArn</name> <description> <para>The cluster's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EcsClusterArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>EcsClusterArn</name> <description> <para>The cluster's ARN. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the EcsClusterArn parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the EcsClusterArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeregisterEcsClusterResponse) 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=Unregister-OPSEcsCluster.html&tocid=Unregister-OPSEcsCluster</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Unregister-OPSElasticIp</name> <description> <para>Invokes the DeregisterElasticIp operation against AWS OpsWorks.</para> </description> <verb>Unregister</verb> <noun>OPSElasticIp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Unregister-OPSElasticIp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ElasticIp</name> <description> <para>The Elastic IP address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ElasticIp parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ElasticIp</name> <description> <para>The Elastic IP address. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ElasticIp parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ElasticIp parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeregisterElasticIpResponse) 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=Unregister-OPSElasticIp.html&tocid=Unregister-OPSElasticIp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Unregister-OPSInstance</name> <description> <para>Invokes the DeregisterInstance operation against AWS OpsWorks.</para> </description> <verb>Unregister</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks Stacks. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Unregister-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeregisterInstanceResponse) 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=Unregister-OPSInstance.html&tocid=Unregister-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Unregister-OPSInstanceAssignment</name> <description> <para>Invokes the UnassignInstance operation against AWS OpsWorks.</para> </description> <verb>Unregister</verb> <noun>OPSInstanceAssignment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Unregister-OPSInstanceAssignment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UnassignInstanceResponse) 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=Unregister-OPSInstanceAssignment.html&tocid=Unregister-OPSInstanceAssignment</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Unregister-OPSRdsDbInstance</name> <description> <para>Invokes the DeregisterRdsDbInstance operation against AWS OpsWorks.</para> </description> <verb>Unregister</verb> <noun>OPSRdsDbInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deregisters an Amazon RDS instance. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Unregister-OPSRdsDbInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RdsDbInstanceArn</name> <description> <para>The Amazon RDS instance's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RdsDbInstanceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RdsDbInstanceArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>RdsDbInstanceArn</name> <description> <para>The Amazon RDS instance's ARN. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the RdsDbInstanceArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeregisterRdsDbInstanceResponse) 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=Unregister-OPSRdsDbInstance.html&tocid=Unregister-OPSRdsDbInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Unregister-OPSVolume</name> <description> <para>Invokes the DeregisterVolume operation against AWS OpsWorks.</para> </description> <verb>Unregister</verb> <noun>OPSVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Unregister-OPSVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>VolumeId</name> <description> <para>The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>VolumeId</name> <description> <para>The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the VolumeId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.DeregisterVolumeResponse) 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=Unregister-OPSVolume.html&tocid=Unregister-OPSVolume</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSApp</name> <description> <para>Invokes the UpdateApp operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSApp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a specified app. <b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSApp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AppId</name> <description> <para>The app ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key/value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SslConfiguration_Certificate</name> <description> <para>The contents of the certificate's domain.crt file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SslConfiguration_Chain</name> <description> <para>Optional. Can be used to specify an intermediate certificate authority key or client authentication. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DataSource</name> <description> <para>The app's data sources. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.DataSource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A description of the app. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Domain</name> <description> <para>The app's virtual host settings, with multiple domains separated by commas. For example: <code>'www.example.com, example.com'</code> </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableSsl</name> <description> <para>Whether SSL is enabled for the app. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Environment</name> <description> <para>An array of <code>EnvironmentVariable</code> objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment"> Environment Variables</a>. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)." This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.EnvironmentVariable[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The app name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SslConfiguration_PrivateKey</name> <description> <para>The private key; the contents of the certificate's domain.kex file. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Type</name> <description> <para>The app type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.AppType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AppId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>AppId</name> <description> <para>The app ID. </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="False" position="Named"> <name>AppSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>AppSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </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="False" position="Named"> <name>AppSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>AppSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> <type> <name>Amazon.OpsWorks.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AppSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </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="False" position="Named"> <name>AppSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </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="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key/value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DataSource</name> <description> <para>The app's data sources. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.DataSource[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.DataSource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A description of the app. </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="False" position="Named"> <name>Domain</name> <description> <para>The app's virtual host settings, with multiple domains separated by commas. For example: <code>'www.example.com, example.com'</code> </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="False" position="Named"> <name>EnableSsl</name> <description> <para>Whether SSL is enabled for the app. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Environment</name> <description> <para>An array of <code>EnvironmentVariable</code> objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment"> Environment Variables</a>. There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)." This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.EnvironmentVariable[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.EnvironmentVariable[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Name</name> <description> <para>The app name. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AppId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>SslConfiguration_Certificate</name> <description> <para>The contents of the certificate's domain.crt file. </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="False" position="Named"> <name>SslConfiguration_Chain</name> <description> <para>Optional. Can be used to specify an intermediate certificate authority key or client authentication. </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="False" position="Named"> <name>SslConfiguration_PrivateKey</name> <description> <para>The private key; the contents of the certificate's domain.kex file. </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="False" position="Named"> <name>Type</name> <description> <para>The app type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.AppType</parameterValue> <type> <name>Amazon.OpsWorks.AppType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AppId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateAppResponse) 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=Update-OPSApp.html&tocid=Update-OPSApp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSElasticIp</name> <description> <para>Invokes the UpdateElasticIp operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSElasticIp</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a registered Elastic IP address's name. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSElasticIp</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The address. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The new name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ElasticIp</name> <description> <para>The address. </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="False" 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="False" position="Named"> <name>Name</name> <description> <para>The new name. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.OpsWorks.Model.UpdateElasticIpResponse) 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=Update-OPSElasticIp.html&tocid=Update-OPSElasticIp</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSInstance</name> <description> <para>Invokes the UpdateInstance operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a specified instance. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - <code>INHERIT</code> - Use the stack's default agent version setting. - <i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance. The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AmiId</name> <description> <para>The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Architecture</name> <description> <para>The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Architecture</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingType</name> <description> <para>For load-based or time-based instances, the type. Windows stacks can use only time-based instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.AutoScalingType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EbsOptimized</name> <description> <para>This property cannot be updated. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Hostname</name> <description> <para>The instance host name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstallUpdatesOnBoot</name> <description> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstanceType</name> <description> <para>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>LayerId</name> <description> <para>The instance's layer IDs. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Os</name> <description> <para>The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI. - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SshKeyName</name> <description> <para>The instance's Amazon EC2 key name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - <code>INHERIT</code> - Use the stack's default agent version setting. - <i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance. The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. </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="False" position="Named"> <name>AmiId</name> <description> <para>The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs. </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="False" position="Named"> <name>Architecture</name> <description> <para>The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Architecture</parameterValue> <type> <name>Amazon.OpsWorks.Architecture</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoScalingType</name> <description> <para>For load-based or time-based instances, the type. Windows stacks can use only time-based instances. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.AutoScalingType</parameterValue> <type> <name>Amazon.OpsWorks.AutoScalingType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EbsOptimized</name> <description> <para>This property cannot be updated. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>Hostname</name> <description> <para>The instance host name. </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="False" position="Named"> <name>InstallUpdatesOnBoot</name> <description> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>InstanceId</name> <description> <para>The instance ID. </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="False" position="Named"> <name>InstanceType</name> <description> <para>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table. </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>LayerId</name> <description> <para>The instance's layer IDs. </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="False" position="Named"> <name>Os</name> <description> <para>The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI. - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>SshKeyName</name> <description> <para>The instance's Amazon EC2 key name. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the InstanceId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateInstanceResponse) 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=Update-OPSInstance.html&tocid=Update-OPSInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSLayer</name> <description> <para>Invokes the UpdateLayer operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSLayer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a specified layer. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSLayer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>The layer ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key/value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoAssignElasticIp</name> <description> <para>Whether to automatically assign an <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoAssignPublicIp</name> <description> <para>For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Configure</name> <description> <para>An array of custom recipe names to be run following a <code>configure</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomInstanceProfileArn</name> <description> <para>The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomJson</name> <description> <para>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomSecurityGroupId</name> <description> <para>An array containing the layer's custom security group IDs. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Shutdown_DelayUntilElbConnectionsDrained</name> <description> <para>Whether to enable Elastic Load Balancing connection draining. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Deploy</name> <description> <para>An array of custom recipe names to be run following a <code>deploy</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EnableAutoHealing</name> <description> <para>Whether to disable auto healing for the layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsConfiguration_Enabled</name> <description> <para>Whether CloudWatch Logs is enabled for a layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Shutdown_ExecutionTimeout</name> <description> <para>The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstallUpdatesOnBoot</name> <description> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsConfiguration_LogStream</name> <description> <para>A list of configuration options for CloudWatch Logs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.CloudWatchLogsLogStream[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The layer name, which is used by the console. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Package</name> <description> <para>An array of <code>Package</code> objects that describe the layer's packages. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Setup</name> <description> <para>An array of custom recipe names to be run following a <code>setup</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Shortname</name> <description> <para>For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/. The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer Reference</a> </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Shutdown</name> <description> <para>An array of custom recipe names to be run following a <code>shutdown</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomRecipes_Undeploy</name> <description> <para>An array of custom recipe names to be run following a <code>undeploy</code> event. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseEbsOptimizedInstance</name> <description> <para>Whether to use Amazon EBS-optimized instances. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VolumeConfiguration</name> <description> <para>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.VolumeConfiguration[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key/value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoAssignElasticIp</name> <description> <para>Whether to automatically assign an <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoAssignPublicIp</name> <description> <para>For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsConfiguration_Enabled</name> <description> <para>Whether CloudWatch Logs is enabled for a layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CloudWatchLogsConfiguration_LogStream</name> <description> <para>A list of configuration options for CloudWatch Logs. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.CloudWatchLogsLogStream[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.CloudWatchLogsLogStream[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomInstanceProfileArn</name> <description> <para>The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </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="False" position="Named"> <name>CustomJson</name> <description> <para>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>. </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="False" position="Named"> <name>CustomRecipes_Configure</name> <description> <para>An array of custom recipe names to be run following a <code>configure</code> event. </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="False" position="Named"> <name>CustomRecipes_Deploy</name> <description> <para>An array of custom recipe names to be run following a <code>deploy</code> event. </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="False" position="Named"> <name>CustomRecipes_Setup</name> <description> <para>An array of custom recipe names to be run following a <code>setup</code> event. </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="False" position="Named"> <name>CustomRecipes_Shutdown</name> <description> <para>An array of custom recipe names to be run following a <code>shutdown</code> event. </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="False" position="Named"> <name>CustomRecipes_Undeploy</name> <description> <para>An array of custom recipe names to be run following a <code>undeploy</code> event. </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="False" position="Named"> <name>CustomSecurityGroupId</name> <description> <para>An array containing the layer's custom security group IDs. </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="False" position="Named"> <name>EnableAutoHealing</name> <description> <para>Whether to disable auto healing for the layer. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>InstallUpdatesOnBoot</name> <description> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>LayerId</name> <description> <para>The layer ID. </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="False" position="Named"> <name>Name</name> <description> <para>The layer name, which is used by the console. </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="False" position="Named"> <name>Package</name> <description> <para>An array of <code>Package</code> objects that describe the layer's packages. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Shortname</name> <description> <para>For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/. The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer Reference</a> </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="False" position="Named"> <name>Shutdown_DelayUntilElbConnectionsDrained</name> <description> <para>Whether to enable Elastic Load Balancing connection draining. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Shutdown_ExecutionTimeout</name> <description> <para>The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseEbsOptimizedInstance</name> <description> <para>Whether to use Amazon EBS-optimized instances. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VolumeConfiguration</name> <description> <para>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.Model.VolumeConfiguration[]</parameterValue> <type> <name>Amazon.OpsWorks.Model.VolumeConfiguration[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the LayerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateLayerResponse) 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=Update-OPSLayer.html&tocid=Update-OPSLayer</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSMyUserProfile</name> <description> <para>Invokes the UpdateMyUserProfile operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSMyUserProfile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a user's SSH public key. <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSMyUserProfile</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SshPublicKey</name> <description> <para>The user's SSH public key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SshPublicKey parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the SshPublicKey parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>SshPublicKey</name> <description> <para>The user's SSH public key. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the SshPublicKey parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateMyUserProfileResponse) 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=Update-OPSMyUserProfile.html&tocid=Update-OPSMyUserProfile</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSRdsDbInstance</name> <description> <para>Invokes the UpdateRdsDbInstance operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSRdsDbInstance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an Amazon RDS instance. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSRdsDbInstance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>RdsDbInstanceArn</name> <description> <para>The Amazon RDS instance's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbPassword</name> <description> <para>The database password. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbUser</name> <description> <para>The master user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RdsDbInstanceArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DbPassword</name> <description> <para>The database password. </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="False" position="Named"> <name>DbUser</name> <description> <para>The master user name. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the RdsDbInstanceArn parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>RdsDbInstanceArn</name> <description> <para>The Amazon RDS instance's ARN. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the RdsDbInstanceArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateRdsDbInstanceResponse) 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=Update-OPSRdsDbInstance.html&tocid=Update-OPSRdsDbInstance</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSStack</name> <description> <para>Invokes the UpdateStack operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSStack</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a specified stack. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSStack</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key-value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_BerkshelfVersion</name> <description> <para>The Berkshelf version. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomJson</name> <description> <para>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format: <code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code> For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultAvailabilityZone</name> <description> <para>The stack's default Availability Zone, which must be in the stack's region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see <a>CreateStack</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultInstanceProfileArn</name> <description> <para>The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultOs</name> <description> <para>The stack's operating system, which must be set to one of the following: - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. - A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. The default option is the stack's current operating system. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultRootDeviceType</name> <description> <para>The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.RootDeviceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSshKeyName</name> <description> <para>A default Amazon EC2 key-pair name. The default value is <code>none</code>. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSubnetId</name> <description> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HostnameTheme</name> <description> <para>The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are: - <code>Baked_Goods</code> - <code>Clouds</code> - <code>Europe_Cities</code> - <code>Fruits</code> - <code>Greek_Deities</code> - <code>Legendary_creatures_from_Japan</code> - <code>Planets_and_Moons</code> - <code>Roman_Deities</code> - <code>Scottish_Islands</code> - <code>US_Cities</code> - <code>Wild_Cats</code> To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_ManageBerkshelf</name> <description> <para>Whether to enable Berkshelf. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Name</name> <description> <para>The name. This parameter must be set to "Chef". </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The stack's new name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>Do not use this parameter. You cannot update a stack's service role. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseCustomCookbook</name> <description> <para>Whether the stack uses custom cookbooks. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseOpsworksSecurityGroup</name> <description> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. <code>UseOpsworksSecurityGroups</code> allows you to provide your own custom security groups instead of using the built-in groups. <code>UseOpsworksSecurityGroups</code> has the following settings: - True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. - False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Version</name> <description> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AgentVersion</name> <description> <para>The default AWS OpsWorks Stacks agent version. You have the following options: - Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances. The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>. AgentVersion cannot be set to Chef 12.2. You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. </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="False" position="Named"> <name>Attribute</name> <description> <para>One or more user-defined key-value pairs to be added to the stack attributes. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ChefConfiguration_BerkshelfVersion</name> <description> <para>The Berkshelf version. </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="False" position="Named"> <name>ChefConfiguration_ManageBerkshelf</name> <description> <para>Whether to enable Berkshelf. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ConfigurationManager_Name</name> <description> <para>The name. This parameter must be set to "Chef". </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="False" position="Named"> <name>ConfigurationManager_Version</name> <description> <para>The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4. </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="False" position="Named"> <name>CustomCookbooksSource_Password</name> <description> <para>When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set <code>Password</code> to the password. For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html</a>. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>CustomCookbooksSource_Revision</name> <description> <para>The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. </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="False" position="Named"> <name>CustomCookbooksSource_SshKey</name> <description> <para>In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns <code>*****FILTERED*****</code> instead of the actual value. </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="False" position="Named"> <name>CustomCookbooksSource_Type</name> <description> <para>The repository type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.SourceType</parameterValue> <type> <name>Amazon.OpsWorks.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>CustomCookbooksSource_Url</name> <description> <para>The source URL. The following is an example of an Amazon S3 source URL: <code>https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz</code>. </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="False" position="Named"> <name>CustomCookbooksSource_Username</name> <description> <para>This parameter depends on the repository type. - For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name. </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="False" position="Named"> <name>CustomJson</name> <description> <para>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format: <code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code> For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>. </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="False" position="Named"> <name>DefaultAvailabilityZone</name> <description> <para>The stack's default Availability Zone, which must be in the stack's region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see <a>CreateStack</a>. </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="False" position="Named"> <name>DefaultInstanceProfileArn</name> <description> <para>The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>. </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="False" position="Named"> <name>DefaultOs</name> <description> <para>The stack's operating system, which must be set to one of the following: - A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>. - A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>. - <code>CentOS Linux 7</code> - <code>Red Hat Enterprise Linux 7</code> - A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>. - A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>. The default option is the stack's current operating system. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>. </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="False" position="Named"> <name>DefaultRootDeviceType</name> <description> <para>The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorks.RootDeviceType</parameterValue> <type> <name>Amazon.OpsWorks.RootDeviceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DefaultSshKeyName</name> <description> <para>A default Amazon EC2 key-pair name. The default value is <code>none</code>. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </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="False" position="Named"> <name>DefaultSubnetId</name> <description> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </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="False" 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="False" position="Named"> <name>HostnameTheme</name> <description> <para>The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are: - <code>Baked_Goods</code> - <code>Clouds</code> - <code>Europe_Cities</code> - <code>Fruits</code> - <code>Greek_Deities</code> - <code>Legendary_creatures_from_Japan</code> - <code>Planets_and_Moons</code> - <code>Roman_Deities</code> - <code>Scottish_Islands</code> - <code>US_Cities</code> - <code>Wild_Cats</code> To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme. </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="False" position="Named"> <name>Name</name> <description> <para>The stack's new name. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>ServiceRoleArn</name> <description> <para>Do not use this parameter. You cannot update a stack's service role. </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 (ByValue, ByPropertyName)" position="1"> <name>StackId</name> <description> <para>The stack ID. </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="False" position="Named"> <name>UseCustomCookbook</name> <description> <para>Whether the stack uses custom cookbooks. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UseOpsworksSecurityGroup</name> <description> <para>Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. <code>UseOpsworksSecurityGroups</code> allows you to provide your own custom security groups instead of using the built-in groups. <code>UseOpsworksSecurityGroups</code> has the following settings: - True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. - False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the StackId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateStackResponse) 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=Update-OPSStack.html&tocid=Update-OPSStack</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSUserProfile</name> <description> <para>Invokes the UpdateUserProfile operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSUserProfile</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates a specified user profile. <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSUserProfile</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>IamUserArn</name> <description> <para>The user IAM ARN. This can also be a federated user's ARN. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowSelfManagement</name> <description> <para>Whether users can specify their own SSH public key through the My Settings page. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html">Managing User Permissions</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SshPublicKey</name> <description> <para>The user's new SSH public key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SshUsername</name> <description> <para>The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, <code>my.name</code> will be changed to <code>myname</code>. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the IamUserArn parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AllowSelfManagement</name> <description> <para>Whether users can specify their own SSH public key through the My Settings page. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html">Managing User Permissions</a>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>IamUserArn</name> <description> <para>The user IAM ARN. This can also be a federated user's ARN. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the IamUserArn parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>SshPublicKey</name> <description> <para>The user's new SSH public key. </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="False" position="Named"> <name>SshUsername</name> <description> <para>The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, <code>my.name</code> will be changed to <code>myname</code>. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the IamUserArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateUserProfileResponse) 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=Update-OPSUserProfile.html&tocid=Update-OPSUserProfile</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Update-OPSVolume</name> <description> <para>Invokes the UpdateVolume operation against AWS OpsWorks.</para> </description> <verb>Update</verb> <noun>OPSVolume</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates an Amazon EBS volume's name or mount point. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </description> <syntax> <syntaxItem> <name>Update-OPSVolume</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>VolumeId</name> <description> <para>The volume ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MountPoint</name> <description> <para>The new mount point. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para>The new name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>MountPoint</name> <description> <para>The new mount point. </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="False" position="Named"> <name>Name</name> <description> <para>The new name. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>VolumeId</name> <description> <para>The volume ID. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the VolumeId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorks.Model.UpdateVolumeResponse) 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=Update-OPSVolume.html&tocid=Update-OPSVolume</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/userguide</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/opsworks/latest/APIReference/</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>Add-OWCMNode</name> <description> <para>Invokes the AssociateNode operation against AWS OpsWorksCM.</para> </description> <verb>Add</verb> <noun>OWCMNode</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates a new node with the Chef server. This command is an alternative to <code>knife bootstrap</code>. For more information about how to disassociate a node, see <a>DisassociateNode</a>. A node can can only be associated with servers that are in a <code>HEALTHY</code> state. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance. Example: <code>aws opsworks-cm associate-node --server-name <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes "Name=<i>MyOrganization</i>,Value=default" "Name=<i>Chef_node_public_key</i>,Value=<i>Public_key_contents</i>"</code> </para> </description> <syntax> <syntaxItem> <name>Add-OWCMNode</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server with which to associate the node. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineAttribute</name> <description> <para>Amazon.OpsWorksCM.Model.AssociateNodeRequest.EngineAttributes </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorksCM.Model.EngineAttribute[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NodeName</name> <description> <para>The name of the Chef client node. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineAttribute</name> <description> <para>Amazon.OpsWorksCM.Model.AssociateNodeRequest.EngineAttributes </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorksCM.Model.EngineAttribute[]</parameterValue> <type> <name>Amazon.OpsWorksCM.Model.EngineAttribute[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>NodeName</name> <description> <para>The name of the Chef client node. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server with which to associate the node. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorksCM.Model.AssociateNodeResponse) 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=Add-OWCMNode.html&tocid=Add-OWCMNode</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>Get-OWCMAccountAttribute</name> <description> <para>Invokes the DescribeAccountAttributes operation against AWS OpsWorksCM.</para> </description> <verb>Get</verb> <noun>OWCMAccountAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes your account attributes, and creates requests to increase limits before they are reached or exceeded. This operation is synchronous. </para> </description> <syntax> <syntaxItem> <name>Get-OWCMAccountAttribute</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.OpsWorksCM.Model.AccountAttribute</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of AccountAttribute objects. The service call response (type Amazon.OpsWorksCM.Model.DescribeAccountAttributesResponse) 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-OWCMAccountAttribute.html&tocid=Get-OWCMAccountAttribute</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>Get-OWCMBackupList</name> <description> <para>Invokes the DescribeBackups operation against AWS OpsWorksCM.</para> </description> <verb>Get</verb> <noun>OWCMBackupList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups. This operation is synchronous. A <code>ResourceNotFoundException</code> is thrown when the backup does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-OWCMBackupList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>Returns backups for the server with the specified ServerName. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupId</name> <description> <para>Describes a single backup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call <code>DescribeBackups</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupId</name> <description> <para>Describes a single backup. </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="False" position="Named"> <name>MaxResult</name> <description> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call <code>DescribeBackups</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>Returns backups for the server with the specified ServerName. </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.OpsWorksCM.Model.Backup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Backup objects. The service call response (type Amazon.OpsWorksCM.Model.DescribeBackupsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-OWCMBackupList.html&tocid=Get-OWCMBackupList</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>Get-OWCMEventList</name> <description> <para>Invokes the DescribeEvents operation against AWS OpsWorksCM.</para> </description> <verb>Get</verb> <noun>OWCMEventList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes events for a specified server. Results are ordered by time, with newest events first. This operation is synchronous. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-OWCMEventList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server for which you want to view events. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call <code>DescribeEvents</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call <code>DescribeEvents</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server for which you want to view events. </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.OpsWorksCM.Model.ServerEvent</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ServerEvent objects. The service call response (type Amazon.OpsWorksCM.Model.DescribeEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-OWCMEventList.html&tocid=Get-OWCMEventList</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>Get-OWCMNodeAssociationStatus</name> <description> <para>Invokes the DescribeNodeAssociationStatus operation against AWS OpsWorksCM.</para> </description> <verb>Get</verb> <noun>OWCMNodeAssociationStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the current status of an existing association or disassociation request. A <code>ResourceNotFoundException</code> is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </description> <syntax> <syntaxItem> <name>Get-OWCMNodeAssociationStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server from which to disassociate the node. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NodeAssociationStatusToken</name> <description> <para>The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NodeAssociationStatusToken</name> <description> <para>The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server from which to disassociate the node. </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.OpsWorksCM.Model.DescribeNodeAssociationStatusResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.OpsWorksCM.Model.DescribeNodeAssociationStatusResponse 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-OWCMNodeAssociationStatus.html&tocid=Get-OWCMNodeAssociationStatus</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>Get-OWCMServerList</name> <description> <para>Invokes the DescribeServers operation against AWS OpsWorksCM.</para> </description> <verb>Get</verb> <noun>OWCMServerList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate does not query other services. This operation is synchronous. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-OWCMServerList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>Describes the server with the specified ServerName. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call <code>DescribeServers</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call <code>DescribeServers</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>Describes the server with the specified ServerName. </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.OpsWorksCM.Model.CMServer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of CMServer objects. The service call response (type Amazon.OpsWorksCM.Model.DescribeServersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-OWCMServerList.html&tocid=Get-OWCMServerList</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>New-OWCMBackup</name> <description> <para>Invokes the CreateBackup operation against AWS OpsWorksCM.</para> </description> <verb>New</verb> <noun>OWCMBackup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an application-level backup of a server. While the server is in the <code>BACKING_UP</code> state, the server cannot be changed, and no additional backup can be created. Backups can be created for servers in <code>RUNNING</code>, <code>HEALTHY</code>, and <code>UNHEALTHY</code> states. By default, you can create a maximum of 50 manual backups. This operation is asynchronous. A <code>LimitExceededException</code> is thrown when the maximum number of manual backups is reached. An <code>InvalidStateException</code> is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A <code>ResourceNotFoundException</code> is thrown when the server is not found. A <code>ValidationException</code> is thrown when parameters of the request are not valid. </para> </description> <syntax> <syntaxItem> <name>New-OWCMBackup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server that you want to back up. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para> A user-defined description of the backup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para> A user-defined description of the backup. </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="False" 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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server that you want to back up. </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.OpsWorksCM.Model.Backup</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Backup object. The service call response (type Amazon.OpsWorksCM.Model.CreateBackupResponse) 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=New-OWCMBackup.html&tocid=New-OWCMBackup</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>New-OWCMServer</name> <description> <para>Invokes the CreateServer operation against AWS OpsWorksCM.</para> </description> <verb>New</verb> <noun>OWCMServer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates and immedately starts a new server. The server is ready to use when it is in the <code>HEALTHY</code> state. By default, you can create a maximum of 10 servers. This operation is asynchronous. A <code>LimitExceededException</code> is thrown when you have created the maximum number of servers (10). A <code>ResourceAlreadyExistsException</code> is thrown when a server with the same name already exists in the account. A <code>ResourceNotFoundException</code> is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A <code>ValidationException</code> is thrown when parameters of the request are not valid. If you do not specify a security group by adding the <code>SecurityGroupIds</code> parameter, AWS OpsWorks creates a new security group. The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22. By default, the Chef Server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console. </para> </description> <syntax> <syntaxItem> <name>New-OWCMServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para> The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociatePublicIpAddress</name> <description> <para> Associate a public IP address with a server that you are launching. Valid values are <code>true</code> or <code>false</code>. The default value is <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupId</name> <description> <para> If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionCount</name> <description> <para> The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks for Chef Automate deletes the oldest backups if this number is exceeded. The default value is <code>1</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DisableAutomatedBackup</name> <description> <para> Enable or disable scheduled backups. Valid values are <code>true</code> or <code>false</code>. The default value is <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Engine</name> <description> <para> The configuration management engine to use. Valid values include <code>Chef</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineAttribute</name> <description> <para>Amazon.OpsWorksCM.Model.CreateServerRequest.EngineAttributes </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorksCM.Model.EngineAttribute[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineModel</name> <description> <para> The engine model, or option. Valid values include <code>Single</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineVersion</name> <description> <para> The major release version of the engine that you want to use. Values depend on the engine that you choose. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstanceProfileArn</name> <description> <para> The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstanceType</name> <description> <para> The Amazon EC2 instance type to use. Valid values must be specified in the following format: <code>^([cm][34]|t2).*</code> For example, <code>m4.large</code>. Valid values are <code>t2.medium</code>, <code>m4.large</code>, or <code>m4.2xlarge</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KeyPair</name> <description> <para> The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para> The start time for a one-hour period during which AWS OpsWorks for Chef Automate backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats: - <code>HH:MM</code> for daily backups - <code>DDD:HH:MM</code> for weekly backups The specified time is in coordinated universal time (UTC). The default value is a random, daily start time. <b>Example:</b><code>08:00</code>, which represents a daily start time of 08:00 UTC. <b>Example:</b><code>Mon:08:00</code>, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para> The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance. Valid values must be specified in the following format: <code>DDD:HH:MM</code>. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See <code>TimeWindowDefinition</code> for more information. <b>Example:</b><code>Mon:08:00</code>, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SecurityGroupId</name> <description> <para> A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by <code>SubnetIds</code>. If you do not specify this parameter, AWS OpsWorks for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone). </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ServiceRoleArn</name> <description> <para> The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role that you need. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SubnetId</name> <description> <para> The IDs of subnets in which to launch the server EC2 instance. Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled. EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled. For more information about supported Amazon EC2 platforms, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssociatePublicIpAddress</name> <description> <para> Associate a public IP address with a server that you are launching. Valid values are <code>true</code> or <code>false</code>. The default value is <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupId</name> <description> <para> If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId. </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="False" position="Named"> <name>BackupRetentionCount</name> <description> <para> The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks for Chef Automate deletes the oldest backups if this number is exceeded. The default value is <code>1</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DisableAutomatedBackup</name> <description> <para> Enable or disable scheduled backups. Valid values are <code>true</code> or <code>false</code>. The default value is <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Engine</name> <description> <para> The configuration management engine to use. Valid values include <code>Chef</code>. </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="False" position="Named"> <name>EngineAttribute</name> <description> <para>Amazon.OpsWorksCM.Model.CreateServerRequest.EngineAttributes </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorksCM.Model.EngineAttribute[]</parameterValue> <type> <name>Amazon.OpsWorksCM.Model.EngineAttribute[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineModel</name> <description> <para> The engine model, or option. Valid values include <code>Single</code>. </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="False" position="Named"> <name>EngineVersion</name> <description> <para> The major release version of the engine that you want to use. Values depend on the engine that you choose. </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="False" 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="False" position="Named"> <name>InstanceProfileArn</name> <description> <para> The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need. </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="False" position="Named"> <name>InstanceType</name> <description> <para> The Amazon EC2 instance type to use. Valid values must be specified in the following format: <code>^([cm][34]|t2).*</code> For example, <code>m4.large</code>. Valid values are <code>t2.medium</code>, <code>m4.large</code>, or <code>m4.2xlarge</code>. </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="False" position="Named"> <name>KeyPair</name> <description> <para> The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH. </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="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para> The start time for a one-hour period during which AWS OpsWorks for Chef Automate backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats: - <code>HH:MM</code> for daily backups - <code>DDD:HH:MM</code> for weekly backups The specified time is in coordinated universal time (UTC). The default value is a random, daily start time. <b>Example:</b><code>08:00</code>, which represents a daily start time of 08:00 UTC. <b>Example:</b><code>Mon:08:00</code>, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) </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="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para> The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance. Valid values must be specified in the following format: <code>DDD:HH:MM</code>. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See <code>TimeWindowDefinition</code> for more information. <b>Example:</b><code>Mon:08:00</code>, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) </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="False" position="Named"> <name>SecurityGroupId</name> <description> <para> A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by <code>SubnetIds</code>. If you do not specify this parameter, AWS OpsWorks for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone). </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para> The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. </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="False" position="Named"> <name>ServiceRoleArn</name> <description> <para> The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role that you need. </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="False" position="Named"> <name>SubnetId</name> <description> <para> The IDs of subnets in which to launch the server EC2 instance. Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled. EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled. For more information about supported Amazon EC2 platforms, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>. </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.OpsWorksCM.Model.CMServer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CMServer object. The service call response (type Amazon.OpsWorksCM.Model.CreateServerResponse) 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=New-OWCMServer.html&tocid=New-OWCMServer</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-OWCMBackup</name> <description> <para>Invokes the DeleteBackup operation against AWS OpsWorksCM.</para> </description> <verb>Remove</verb> <noun>OWCMBackup</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous. An <code>InvalidStateException</code> is thrown when a backup deletion is already in progress. A <code>ResourceNotFoundException</code> is thrown when the backup does not exist. A <code>ValidationException</code> is thrown when parameters of the request are not valid. </para> </description> <syntax> <syntaxItem> <name>Remove-OWCMBackup</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>BackupId</name> <description> <para>The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format <code>ServerName-yyyyMMddHHmmssSSS</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BackupId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>BackupId</name> <description> <para>The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format <code>ServerName-yyyyMMddHHmmssSSS</code>. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the BackupId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the BackupId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorksCM.Model.DeleteBackupResponse) 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-OWCMBackup.html&tocid=Remove-OWCMBackup</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-OWCMNode</name> <description> <para>Invokes the DisassociateNode operation against AWS OpsWorksCM.</para> </description> <verb>Remove</verb> <noun>OWCMNode</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates a node from a Chef server, and removes the node from the Chef server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the Chef API. For more information about how to associate a node, see <a>AssociateNode</a>. A node can can only be disassociated from a server that is in a <code>HEALTHY</code> state. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </description> <syntax> <syntaxItem> <name>Remove-OWCMNode</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server from which to disassociate the node. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineAttribute</name> <description> <para>Amazon.OpsWorksCM.Model.DisassociateNodeRequest.EngineAttributes </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorksCM.Model.EngineAttribute[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NodeName</name> <description> <para>The name of the Chef client node. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineAttribute</name> <description> <para>Amazon.OpsWorksCM.Model.DisassociateNodeRequest.EngineAttributes </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorksCM.Model.EngineAttribute[]</parameterValue> <type> <name>Amazon.OpsWorksCM.Model.EngineAttribute[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>NodeName</name> <description> <para>The name of the Chef client node. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server from which to disassociate the node. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.OpsWorksCM.Model.DisassociateNodeResponse) 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=Remove-OWCMNode.html&tocid=Remove-OWCMNode</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-OWCMServer</name> <description> <para>Invokes the DeleteServer operation against AWS OpsWorksCM.</para> </description> <verb>Remove</verb> <noun>OWCMServer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance). When you run this command, the server state is updated to <code>DELETING</code>. After the server is deleted, it is no longer returned by <code>DescribeServer</code> requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted. This operation is asynchronous. An <code>InvalidStateException</code> is thrown when a server deletion is already in progress. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </description> <syntax> <syntaxItem> <name>Remove-OWCMServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The ID of the server to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The ID of the server to delete. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ServerName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorksCM.Model.DeleteServerResponse) 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-OWCMServer.html&tocid=Remove-OWCMServer</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>Restore-OWCMServer</name> <description> <para>Invokes the RestoreServer operation against AWS OpsWorksCM.</para> </description> <verb>Restore</verb> <noun>OWCMServer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Restores a backup to a server that is in a <code>CONNECTION_LOST</code>, <code>HEALTHY</code>, <code>RUNNING</code>, <code>UNHEALTHY</code>, or <code>TERMINATED</code> state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work. This operation is asynchronous. An <code>InvalidStateException</code> is thrown when the server is not in a valid state. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </description> <syntax> <syntaxItem> <name>Restore-OWCMServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para> The name of the server that you want to restore. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupId</name> <description> <para> The ID of the backup that you want to use to restore a server. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>InstanceType</name> <description> <para> The type of the instance to create. Valid values must be specified in the following format: <code>^([cm][34]|t2).*</code> For example, <code>m4.large</code>. Valid values are <code>t2.medium</code>, <code>m4.large</code>, and <code>m4.2xlarge</code>. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>KeyPair</name> <description> <para> The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupId</name> <description> <para> The ID of the backup that you want to use to restore a server. </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="False" 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="False" position="Named"> <name>InstanceType</name> <description> <para> The type of the instance to create. Valid values must be specified in the following format: <code>^([cm][34]|t2).*</code> For example, <code>m4.large</code>. Valid values are <code>t2.medium</code>, <code>m4.large</code>, and <code>m4.2xlarge</code>. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup. </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="False" position="Named"> <name>KeyPair</name> <description> <para> The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ServerName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para> The name of the server that you want to restore. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ServerName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.OpsWorksCM.Model.RestoreServerResponse) 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=Restore-OWCMServer.html&tocid=Restore-OWCMServer</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>Start-OWCMMaintenance</name> <description> <para>Invokes the StartMaintenance operation against AWS OpsWorksCM.</para> </description> <verb>Start</verb> <noun>OWCMMaintenance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an <code>UNDER_MAINTENANCE</code> state while maintenance is in progress. Maintenance can only be started on servers in <code>HEALTHY</code> and <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </description> <syntax> <syntaxItem> <name>Start-OWCMMaintenance</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server on which to run maintenance. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineAttribute</name> <description> <para>Engine attributes that are specific to the server on which you want to run maintenance. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorksCM.Model.EngineAttribute[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EngineAttribute</name> <description> <para>Engine attributes that are specific to the server on which you want to run maintenance. </para> </description> <parameterValue required="true" variableLength="false">Amazon.OpsWorksCM.Model.EngineAttribute[]</parameterValue> <type> <name>Amazon.OpsWorksCM.Model.EngineAttribute[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server on which to run maintenance. </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.OpsWorksCM.Model.CMServer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CMServer object. The service call response (type Amazon.OpsWorksCM.Model.StartMaintenanceResponse) 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=Start-OWCMMaintenance.html&tocid=Start-OWCMMaintenance</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>Update-OWCMServer</name> <description> <para>Invokes the UpdateServer operation against AWS OpsWorksCM.</para> </description> <verb>Update</verb> <noun>OWCMServer</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates settings for a server. This operation is synchronous. </para> </description> <syntax> <syntaxItem> <name>Update-OWCMServer</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionCount</name> <description> <para>Sets the number of automated backups that you want to keep. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DisableAutomatedBackup</name> <description> <para>Setting DisableAutomatedBackup to <code>true</code> disables automated or scheduled backups. Automated backups are enabled by default. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BackupRetentionCount</name> <description> <para>Sets the number of automated backups that you want to keep. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DisableAutomatedBackup</name> <description> <para>Setting DisableAutomatedBackup to <code>true</code> disables automated or scheduled backups. Automated backups are enabled by default. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PreferredBackupWindow</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>PreferredMaintenanceWindow</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server to update. </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.OpsWorksCM.Model.CMServer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CMServer object. The service call response (type Amazon.OpsWorksCM.Model.UpdateServerResponse) 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=Update-OWCMServer.html&tocid=Update-OWCMServer</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>Update-OWCMServerEngineAttribute</name> <description> <para>Invokes the UpdateServerEngineAttributes operation against AWS OpsWorksCM.</para> </description> <verb>Update</verb> <noun>OWCMServerEngineAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates engine-specific attributes on a specified server. The server enters the <code>MODIFYING</code> state when this operation is in progress. Only one update can occur at a time. You can use this command to reset the Chef server's private key (<code>CHEF_PIVOTAL_KEY</code>). This operation is asynchronous. This operation can only be called for servers in <code>HEALTHY</code> or <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is raised. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </para> </description> <syntax> <syntaxItem> <name>Update-OWCMServerEngineAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeName</name> <description> <para>The name of the engine attribute to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeValue</name> <description> <para>The value to set for the attribute. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AttributeName</name> <description> <para>The name of the engine attribute to update. </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="False" position="Named"> <name>AttributeValue</name> <description> <para>The value to set for the attribute. </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="False" 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 (ByValue, )" position="1"> <name>ServerName</name> <description> <para>The name of the server to update. </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.OpsWorksCM.Model.CMServer</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a CMServer object. The service call response (type Amazon.OpsWorksCM.Model.UpdateServerEngineAttributesResponse) 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=Update-OWCMServerEngineAttribute.html&tocid=Update-OWCMServerEngineAttribute</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>Add-MTRQualificationToWorker</name> <description> <para>Invokes the AssociateQualificationWithWorker operation against Amazon MTurk Service.</para> </description> <verb>Add</verb> <noun>MTRQualificationToWorker</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>AssociateQualificationWithWorker</code> operation gives a Worker a Qualification. <code>AssociateQualificationWithWorker</code> does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker. You can only assign a Qualification of a Qualification type that you created (using the <code>CreateQualificationType</code> operation). Note: <code>AssociateQualificationWithWorker</code> does not affect any pending Qualification requests for the Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending Qualification request without affecting the Qualification the Worker already has, reject the request with the <code>RejectQualificationRequest</code> operation. </para> </description> <syntax> <syntaxItem> <name>Add-MTRQualificationToWorker</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WorkerId</name> <description> <para> The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IntegerValue</name> <description> <para>The value of the Qualification to assign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the Qualification type to use for the assigned Qualification. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SendNotification</name> <description> <para> Specifies whether to send a notification email message to the Worker saying that the qualification was assigned to the Worker. Note: this is true by default. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>IntegerValue</name> <description> <para>The value of the Qualification to assign. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the Qualification type to use for the assigned Qualification. </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="False" position="Named"> <name>SendNotification</name> <description> <para> Specifies whether to send a notification email message to the Worker saying that the qualification was assigned to the Worker. Note: this is true by default. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WorkerId</name> <description> <para> The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the WorkerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.AssociateQualificationWithWorkerResponse) 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=Add-MTRQualificationToWorker.html&tocid=Add-MTRQualificationToWorker</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>Approve-MTRAssignment</name> <description> <para>Invokes the ApproveAssignment operation against Amazon MTurk Service.</para> </description> <verb>Approve</verb> <noun>MTRAssignment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ApproveAssignment</code> operation approves the results of a completed assignment. Approving an assignment initiates two payments from the Requester's Amazon.com account - The Worker who submitted the results is paid the reward specified in the HIT. - Amazon Mechanical Turk fees are debited. If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site. You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted. </para> </description> <syntax> <syntaxItem> <name>Approve-MTRAssignment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AssignmentId</name> <description> <para> The ID of the assignment. The assignment must correspond to a HIT created by the Requester. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OverrideRejection</name> <description> <para> A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to <code>False</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RequesterFeedback</name> <description> <para> A message for the Worker, which the Worker can see in the Status section of the web site. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AssignmentId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AssignmentId</name> <description> <para> The ID of the assignment. The assignment must correspond to a HIT created by the Requester. </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="False" 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="False" position="Named"> <name>OverrideRejection</name> <description> <para> A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to <code>False</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the AssignmentId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>RequesterFeedback</name> <description> <para> A message for the Worker, which the Worker can see in the Status section of the web site. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the AssignmentId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.ApproveAssignmentResponse) 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=Approve-MTRAssignment.html&tocid=Approve-MTRAssignment</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>Deny-MTRAssignment</name> <description> <para>Invokes the RejectAssignment operation against Amazon MTurk Service.</para> </description> <verb>Deny</verb> <noun>MTRAssignment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>RejectAssignment</code> operation rejects the results of a completed assignment. You can include an optional feedback message with the rejection, which the Worker can see in the Status section of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the assignment was rejected, and can improve the quality of the results the Worker submits in the future. Only the Requester who created the HIT can reject an assignment for the HIT. </para> </description> <syntax> <syntaxItem> <name>Deny-MTRAssignment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentId</name> <description> <para> The ID of the assignment. The assignment must correspond to a HIT created by the Requester. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RequesterFeedback</name> <description> <para> A message for the Worker, which the Worker can see in the Status section of the web site. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentId</name> <description> <para> The ID of the assignment. The assignment must correspond to a HIT created by the Requester. </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="False" 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="False" position="Named"> <name>RequesterFeedback</name> <description> <para> A message for the Worker, which the Worker can see in the Status section of the web site. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.MTurk.Model.RejectAssignmentResponse) 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=Deny-MTRAssignment.html&tocid=Deny-MTRAssignment</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>Deny-MTRQualificationRequest</name> <description> <para>Invokes the RejectQualificationRequest operation against Amazon MTurk Service.</para> </description> <verb>Deny</verb> <noun>MTRQualificationRequest</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>RejectQualificationRequest</code> operation rejects a user's request for a Qualification. You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message. </para> </description> <syntax> <syntaxItem> <name>Deny-MTRQualificationRequest</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationRequestId</name> <description> <para> The ID of the Qualification request, as returned by the <code>ListQualificationRequests</code> operation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Reason</name> <description> <para>A text message explaining why the request was rejected, to be shown to the Worker who made the request. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>QualificationRequestId</name> <description> <para> The ID of the Qualification request, as returned by the <code>ListQualificationRequests</code> operation. </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="False" position="Named"> <name>Reason</name> <description> <para>A text message explaining why the request was rejected, to be shown to the Worker who made the request. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.MTurk.Model.RejectQualificationRequestResponse) 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=Deny-MTRQualificationRequest.html&tocid=Deny-MTRQualificationRequest</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>Get-MTRAccountBalance</name> <description> <para>Invokes the GetAccountBalance operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRAccountBalance</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>GetAccountBalance</code> operation retrieves the amount of money in your Amazon Mechanical Turk account. </para> </description> <syntax> <syntaxItem> <name>Get-MTRAccountBalance</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.MTurk.Model.GetAccountBalanceResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MTurk.Model.GetAccountBalanceResponse 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-MTRAccountBalance.html&tocid=Get-MTRAccountBalance</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>Get-MTRAssignment</name> <description> <para>Invokes the GetAssignment operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRAssignment</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>GetAssignment</code> operation retrieves the details of the specified Assignment. </para> </description> <syntax> <syntaxItem> <name>Get-MTRAssignment</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AssignmentId</name> <description> <para>The ID of the Assignment to be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AssignmentId</name> <description> <para>The ID of the Assignment to be retrieved. </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.MTurk.Model.GetAssignmentResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MTurk.Model.GetAssignmentResponse 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-MTRAssignment.html&tocid=Get-MTRAssignment</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>Get-MTRBonusPaymentList</name> <description> <para>Invokes the ListBonusPayments operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRBonusPaymentList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListBonusPayments</code> operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRBonusPaymentList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HITId</name> <description> <para>The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentId</name> <description> <para>The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentId</name> <description> <para>The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified </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 (ByValue, )" position="1"> <name>HITId</name> <description> <para>The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified </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="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.MTurk.Model.BonusPayment</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of BonusPayment objects. The service call response (type Amazon.MTurk.Model.ListBonusPaymentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRBonusPaymentList.html&tocid=Get-MTRBonusPaymentList</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>Get-MTRFileUploadURL</name> <description> <para>Invokes the GetFileUploadURL operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRFileUploadURL</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>GetFileUploadURL</code> operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. </para> </description> <syntax> <syntaxItem> <name>Get-MTRFileUploadURL</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentId</name> <description> <para>The ID of the assignment that contains the question with a FileUploadAnswer. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QuestionIdentifier</name> <description> <para>The identifier of the question with a FileUploadAnswer, as specified in the QuestionForm of the HIT. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentId</name> <description> <para>The ID of the assignment that contains the question with a FileUploadAnswer. </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="False" position="Named"> <name>QuestionIdentifier</name> <description> <para>The identifier of the question with a FileUploadAnswer, as specified in the QuestionForm of the HIT. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.MTurk.Model.GetFileUploadURLResponse) 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-MTRFileUploadURL.html&tocid=Get-MTRFileUploadURL</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>Get-MTRHIT</name> <description> <para>Invokes the GetHIT operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRHIT</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>GetHIT</code> operation retrieves the details of the specified HIT. </para> </description> <syntax> <syntaxItem> <name>Get-MTRHIT</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HITId</name> <description> <para>The ID of the HIT to be retrieved. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HITId</name> <description> <para>The ID of the HIT to be retrieved. </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.MTurk.Model.HIT</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a HIT object. The service call response (type Amazon.MTurk.Model.GetHITResponse) 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-MTRHIT.html&tocid=Get-MTRHIT</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>Get-MTRHITAssignmentList</name> <description> <para>Invokes the ListAssignmentsForHIT operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRHITAssignmentList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListAssignmentsForHIT</code> operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT. You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation. Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set. Only the Requester who created the HIT can retrieve the assignments for that HIT. Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRHITAssignmentList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentStatus</name> <description> <para>The status of the assignments to return: Submitted | Approved | Rejected </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITId</name> <description> <para>The ID of the HIT. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentStatus</name> <description> <para>The status of the assignments to return: Submitted | Approved | Rejected </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="False" position="Named"> <name>HITId</name> <description> <para>The ID of the HIT. </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="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.MTurk.Model.Assignment</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Assignment objects. The service call response (type Amazon.MTurk.Model.ListAssignmentsForHITResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRHITAssignmentList.html&tocid=Get-MTRHITAssignmentList</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>Get-MTRHITList</name> <description> <para>Invokes the ListHITs operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRHITList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListHITs</code> operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRHITList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.MTurk.Model.HIT</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HIT objects. The service call response (type Amazon.MTurk.Model.ListHITsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRHITList.html&tocid=Get-MTRHITList</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>Get-MTRHITListForQualificationType</name> <description> <para>Invokes the ListHITsForQualificationType operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRHITListForQualificationType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListHITsForQualificationType</code> operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted with the <code>DeleteHIT</code> operation or that have been auto-deleted.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRHITListForQualificationType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>QualificationTypeId</name> <description> <para> The ID of the Qualification type to use when querying HITs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> Limit the number of results returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination Token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> Limit the number of results returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination Token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>QualificationTypeId</name> <description> <para> The ID of the Qualification type to use when querying HITs. </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.MTurk.Model.HIT</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HIT objects. The service call response (type Amazon.MTurk.Model.ListHITsForQualificationTypeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRHITListForQualificationType.html&tocid=Get-MTRHITListForQualificationType</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>Get-MTRQualificationRequestList</name> <description> <para>Invokes the ListQualificationRequests operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRQualificationRequestList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListQualificationRequests</code> operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRQualificationRequestList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>QualificationTypeId</name> <description> <para>The ID of the QualificationType. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> The maximum number of results to return in a single call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> The maximum number of results to return in a single call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>QualificationTypeId</name> <description> <para>The ID of the QualificationType. </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.MTurk.Model.QualificationRequest</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of QualificationRequest objects. The service call response (type Amazon.MTurk.Model.ListQualificationRequestsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRQualificationRequestList.html&tocid=Get-MTRQualificationRequestList</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>Get-MTRQualificationScore</name> <description> <para>Invokes the GetQualificationScore operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRQualificationScore</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>GetQualificationScore</code> operation returns the value of a Worker's Qualification for a given Qualification type. To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment data returned by the <code>ListAssignmentsForHIT</code> operation. Only the owner of a Qualification type can query the value of a Worker's Qualification of that type. </para> </description> <syntax> <syntaxItem> <name>Get-MTRQualificationScore</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker whose Qualification is being updated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the QualificationType. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the QualificationType. </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 (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker whose Qualification is being updated. </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.MTurk.Model.Qualification</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Qualification object. The service call response (type Amazon.MTurk.Model.GetQualificationScoreResponse) 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-MTRQualificationScore.html&tocid=Get-MTRQualificationScore</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>Get-MTRQualificationType</name> <description> <para>Invokes the GetQualificationType operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRQualificationType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>GetQualificationType</code>operation retrieves information about a Qualification type using its ID. </para> </description> <syntax> <syntaxItem> <name>Get-MTRQualificationType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>QualificationTypeId</name> <description> <para>The ID of the QualificationType. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>QualificationTypeId</name> <description> <para>The ID of the QualificationType. </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.MTurk.Model.QualificationType</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a QualificationType object. The service call response (type Amazon.MTurk.Model.GetQualificationTypeResponse) 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-MTRQualificationType.html&tocid=Get-MTRQualificationType</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>Get-MTRQualificationTypeList</name> <description> <para>Invokes the ListQualificationTypes operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRQualificationTypeList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListQualificationRequests</code> operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRQualificationTypeList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MustBeOwnedByCaller</name> <description> <para> Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MustBeRequestable</name> <description> <para>Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Query</name> <description> <para> A text query against all of the searchable attributes of Qualification types. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> The maximum number of results to return in a single call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> The maximum number of results to return in a single call. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MustBeOwnedByCaller</name> <description> <para> Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MustBeRequestable</name> <description> <para>Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Query</name> <description> <para> A text query against all of the searchable attributes of Qualification types. </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.MTurk.Model.QualificationType</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of QualificationType objects. The service call response (type Amazon.MTurk.Model.ListQualificationTypesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRQualificationTypeList.html&tocid=Get-MTRQualificationTypeList</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>Get-MTRReviewableHITList</name> <description> <para>Invokes the ListReviewableHITs operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRReviewableHITList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListReviewableHITs</code> operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRReviewableHITList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITTypeId</name> <description> <para> The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Status</name> <description> <para> Can be either <code>Reviewable</code> or <code>Reviewing</code>. Reviewable is the default value. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.ReviewableHITStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> Limit the number of results returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination Token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITTypeId</name> <description> <para> The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered </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="False" position="Named"> <name>MaxResult</name> <description> <para> Limit the number of results returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination Token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Status</name> <description> <para> Can be either <code>Reviewable</code> or <code>Reviewing</code>. Reviewable is the default value. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.ReviewableHITStatus</parameterValue> <type> <name>Amazon.MTurk.ReviewableHITStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MTurk.Model.HIT</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of HIT objects. The service call response (type Amazon.MTurk.Model.ListReviewableHITsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRReviewableHITList.html&tocid=Get-MTRReviewableHITList</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>Get-MTRReviewPolicyResultList</name> <description> <para>Invokes the ListReviewPolicyResultsForHIT operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRReviewPolicyResultList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListReviewPolicyResultsForHIT</code> operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results. </para> </description> <syntax> <syntaxItem> <name>Get-MTRReviewPolicyResultList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITId</name> <description> <para>The unique identifier of the HIT to retrieve review results for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PolicyLevel</name> <description> <para> The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetrieveAction</name> <description> <para> Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetrieveResult</name> <description> <para> Specify if the operation should retrieve a list of the results computed by the Review Policies. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Limit the number of results returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITId</name> <description> <para>The unique identifier of the HIT to retrieve review results for. </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="False" position="Named"> <name>MaxResult</name> <description> <para>Limit the number of results returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>PolicyLevel</name> <description> <para> The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies. </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="False" position="Named"> <name>RetrieveAction</name> <description> <para> Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetrieveResult</name> <description> <para> Specify if the operation should retrieve a list of the results computed by the Review Policies. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MTurk.Model.ListReviewPolicyResultsForHITResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MTurk.Model.ListReviewPolicyResultsForHITResponse 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-MTRReviewPolicyResultList.html&tocid=Get-MTRReviewPolicyResultList</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>Get-MTRWorkerBlockList</name> <description> <para>Invokes the ListWorkerBlocks operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRWorkerBlockList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListWorkersBlocks</code> operation retrieves a list of Workers who are blocked from working on your HITs.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRWorkerBlockList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.MTurk.Model.WorkerBlock</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of WorkerBlock objects. The service call response (type Amazon.MTurk.Model.ListWorkerBlocksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRWorkerBlockList.html&tocid=Get-MTRWorkerBlockList</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>Get-MTRWorkersWithQualificationType</name> <description> <para>Invokes the ListWorkersWithQualificationType operation against Amazon MTurk Service.</para> </description> <verb>Get</verb> <noun>MTRWorkersWithQualificationType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>ListWorkersWithQualificationType</code> operation returns all of the Workers that have been associated with a given Qualification type.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MTRWorkersWithQualificationType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the Qualification type of the Qualifications to return. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Status</name> <description> <para> The status of the Qualifications to return. Can be <code>Granted | Revoked</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.QualificationStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> Limit the number of results returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination Token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para> Limit the number of results returned. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>Pagination Token <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the Qualification type of the Qualifications to return. </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="False" position="Named"> <name>Status</name> <description> <para> The status of the Qualifications to return. Can be <code>Granted | Revoked</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.QualificationStatus</parameterValue> <type> <name>Amazon.MTurk.QualificationStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MTurk.Model.Qualification</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Qualification objects. The service call response (type Amazon.MTurk.Model.ListWorkersWithQualificationTypeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String), NumResults (type System.Int32)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MTRWorkersWithQualificationType.html&tocid=Get-MTRWorkersWithQualificationType</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>Grant-MTRQualificationRequest</name> <description> <para>Invokes the AcceptQualificationRequest operation against Amazon MTurk Service.</para> </description> <verb>Grant</verb> <noun>MTRQualificationRequest</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>AcceptQualificationRequest</code> operation approves a Worker's request for a Qualification. Only the owner of the Qualification type can grant a Qualification request for that type. A successful request for the <code>AcceptQualificationRequest</code> operation returns with no errors and an empty body. </para> </description> <syntax> <syntaxItem> <name>Grant-MTRQualificationRequest</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>IntegerValue</name> <description> <para> The value of the Qualification. You can omit this value if you are using the presence or absence of the Qualification as the basis for a HIT requirement. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationRequestId</name> <description> <para>The ID of the Qualification request, as returned by the <code>GetQualificationRequests</code> operation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>IntegerValue</name> <description> <para> The value of the Qualification. You can omit this value if you are using the presence or absence of the Qualification as the basis for a HIT requirement. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationRequestId</name> <description> <para>The ID of the Qualification request, as returned by the <code>GetQualificationRequests</code> operation. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.MTurk.Model.AcceptQualificationRequestResponse) 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=Grant-MTRQualificationRequest.html&tocid=Grant-MTRQualificationRequest</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>New-MTRAdditionalAssignmentsForHIT</name> <description> <para>Invokes the CreateAdditionalAssignmentsForHIT operation against Amazon MTurk Service.</para> </description> <verb>New</verb> <noun>MTRAdditionalAssignmentsForHIT</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>CreateAdditionalAssignmentsForHIT</code> operation increases the maximum number of assignments of an existing HIT. To extend the maximum number of assignments, specify the number of additional assignments. - HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an <code>AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease</code> exception. - HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an <code>AWS.MechanicalTurk.HITTooOldForExtension</code> exception. </para> </description> <syntax> <syntaxItem> <name>New-MTRAdditionalAssignmentsForHIT</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITId</name> <description> <para>The ID of the HIT to extend. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NumberOfAdditionalAssignment</name> <description> <para>The number of additional assignments to request for this HIT. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UniqueRequestToken</name> <description> <para> A unique identifier for this request, which allows you to retry the call on error without extending the HIT multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the extend HIT already exists in the system from a previous call using the same <code>UniqueRequestToken</code>, subsequent calls will return an error with a message containing the request ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>HITId</name> <description> <para>The ID of the HIT to extend. </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="False" position="Named"> <name>NumberOfAdditionalAssignment</name> <description> <para>The number of additional assignments to request for this HIT. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UniqueRequestToken</name> <description> <para> A unique identifier for this request, which allows you to retry the call on error without extending the HIT multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the extend HIT already exists in the system from a previous call using the same <code>UniqueRequestToken</code>, subsequent calls will return an error with a message containing the request ID. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.MTurk.Model.CreateAdditionalAssignmentsForHITResponse) 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=New-MTRAdditionalAssignmentsForHIT.html&tocid=New-MTRAdditionalAssignmentsForHIT</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>New-MTRHIT</name> <description> <para>Invokes the CreateHIT operation against Amazon MTurk Service.</para> </description> <verb>New</verb> <noun>MTRHIT</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>CreateHIT</code> operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical Turk website. This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to <code>CreateHIT</code>, a new HIT is created for you, with a new <code>HITTypeID</code>. The HITTypeID can be used to create additional HITs in the future without needing to specify common parameters such as the title, description and reward amount each time. An alternative way to create HITs is to first generate a HITTypeID using the <code>CreateHITType</code> operation and then call the <code>CreateHITWithHITType</code> operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. CreateHIT also supports several ways to provide question data: by providing a value for the <code>Question</code> parameter that fully specifies the contents of the HIT, or by providing a <code>HitLayoutId</code> and associated <code>HitLayoutParameters</code>. If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see <a href="https://requester.mturk.com/pricing">Amazon Mechanical Turk Pricing</a>. </para> </description> <syntax> <syntaxItem> <name>New-MTRHIT</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentDurationInSecond</name> <description> <para> The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoApprovalDelayInSecond</name> <description> <para> The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para> A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITLayoutId</name> <description> <para> The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId parameter must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITLayoutParameter</name> <description> <para> If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.HITLayoutParameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Keyword</name> <description> <para> One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LifetimeInSecond</name> <description> <para> An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxAssignment</name> <description> <para> The number of times the HIT can be accepted and completed before the HIT becomes unavailable. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentReviewPolicy_Parameter</name> <description> <para>Name of the parameter from the Review policy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.PolicyParameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITReviewPolicy_Parameter</name> <description> <para>Name of the parameter from the Review policy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.PolicyParameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentReviewPolicy_PolicyName</name> <description> <para> Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITReviewPolicy_PolicyName</name> <description> <para> Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationRequirement</name> <description> <para> A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the HIT. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.QualificationRequirement[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Question</name> <description> <para> The data the person completing the HIT uses to produce the results. Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId parameter must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RequesterAnnotation</name> <description> <para> An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester. The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Reward</name> <description> <para> The amount of money the Requester will pay a Worker for successfully completing the HIT. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Title</name> <description> <para> The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UniqueRequestToken</name> <description> <para> A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentDurationInSecond</name> <description> <para> The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentReviewPolicy_Parameter</name> <description> <para>Name of the parameter from the Review policy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.PolicyParameter[]</parameterValue> <type> <name>Amazon.MTurk.Model.PolicyParameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentReviewPolicy_PolicyName</name> <description> <para> Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 </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="False" position="Named"> <name>AutoApprovalDelayInSecond</name> <description> <para> The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para> A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it. </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="False" 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="False" position="Named"> <name>HITLayoutId</name> <description> <para> The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId parameter must be provided. </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="False" position="Named"> <name>HITLayoutParameter</name> <description> <para> If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.HITLayoutParameter[]</parameterValue> <type> <name>Amazon.MTurk.Model.HITLayoutParameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITReviewPolicy_Parameter</name> <description> <para>Name of the parameter from the Review policy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.PolicyParameter[]</parameterValue> <type> <name>Amazon.MTurk.Model.PolicyParameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITReviewPolicy_PolicyName</name> <description> <para> Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 </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="False" position="Named"> <name>Keyword</name> <description> <para> One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs. </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="False" position="Named"> <name>LifetimeInSecond</name> <description> <para> An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxAssignment</name> <description> <para> The number of times the HIT can be accepted and completed before the HIT becomes unavailable. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationRequirement</name> <description> <para> A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the HIT. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.QualificationRequirement[]</parameterValue> <type> <name>Amazon.MTurk.Model.QualificationRequirement[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Question</name> <description> <para> The data the person completing the HIT uses to produce the results. Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId parameter must be provided. </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="False" position="Named"> <name>RequesterAnnotation</name> <description> <para> An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester. The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped. </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="False" position="Named"> <name>Reward</name> <description> <para> The amount of money the Requester will pay a Worker for successfully completing the HIT. </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="False" position="Named"> <name>Title</name> <description> <para> The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned. </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="False" position="Named"> <name>UniqueRequestToken</name> <description> <para> A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs. </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.MTurk.Model.HIT</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a HIT object. The service call response (type Amazon.MTurk.Model.CreateHITResponse) 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=New-MTRHIT.html&tocid=New-MTRHIT</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>New-MTRHITType</name> <description> <para>Invokes the CreateHITType operation against Amazon MTurk Service.</para> </description> <verb>New</verb> <noun>MTRHITType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>CreateHITType</code> operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned. </para> </description> <syntax> <syntaxItem> <name>New-MTRHITType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Title</name> <description> <para> The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentDurationInSecond</name> <description> <para> The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoApprovalDelayInSecond</name> <description> <para> The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para> A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Keyword</name> <description> <para> One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationRequirement</name> <description> <para> A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the HIT. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.QualificationRequirement[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Reward</name> <description> <para> The amount of money the Requester will pay a Worker for successfully completing the HIT. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentDurationInSecond</name> <description> <para> The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoApprovalDelayInSecond</name> <description> <para> The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para> A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it. </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="False" 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="False" position="Named"> <name>Keyword</name> <description> <para> One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs. </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="False" position="Named"> <name>QualificationRequirement</name> <description> <para> A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the HIT. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.QualificationRequirement[]</parameterValue> <type> <name>Amazon.MTurk.Model.QualificationRequirement[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Reward</name> <description> <para> The amount of money the Requester will pay a Worker for successfully completing the HIT. </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 (ByValue, )" position="1"> <name>Title</name> <description> <para> The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.MTurk.Model.CreateHITTypeResponse) 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=New-MTRHITType.html&tocid=New-MTRHITType</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>New-MTRHITWithHITType</name> <description> <para>Invokes the CreateHITWithHITType operation against Amazon MTurk Service.</para> </description> <verb>New</verb> <noun>MTRHITWithHITType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>CreateHITWithHITType</code> operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the <code>CreateHITType</code> operation. This is an alternative way to create HITs from the <code>CreateHIT</code> operation. This is the recommended best practice for Requesters who are creating large numbers of HITs. CreateHITWithHITType also supports several ways to provide question data: by providing a value for the <code>Question</code> parameter that fully specifies the contents of the HIT, or by providing a <code>HitLayoutId</code> and associated <code>HitLayoutParameters</code>. If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see <a href="https://requester.mturk.com/pricing">Amazon Mechanical Turk Pricing</a>. </para> </description> <syntax> <syntaxItem> <name>New-MTRHITWithHITType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HITTypeId</name> <description> <para>The HIT type ID you want to create this HIT with. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITLayoutId</name> <description> <para> The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId parameter must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITLayoutParameter</name> <description> <para> If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.HITLayoutParameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LifetimeInSecond</name> <description> <para> An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxAssignment</name> <description> <para> The number of times the HIT can be accepted and completed before the HIT becomes unavailable. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentReviewPolicy_Parameter</name> <description> <para>Name of the parameter from the Review policy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.PolicyParameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITReviewPolicy_Parameter</name> <description> <para>Name of the parameter from the Review policy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.PolicyParameter[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentReviewPolicy_PolicyName</name> <description> <para> Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITReviewPolicy_PolicyName</name> <description> <para> Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Question</name> <description> <para> The data the person completing the HIT uses to produce the results. Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId parameter must be provided. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RequesterAnnotation</name> <description> <para> An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester. The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UniqueRequestToken</name> <description> <para> A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentReviewPolicy_Parameter</name> <description> <para>Name of the parameter from the Review policy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.PolicyParameter[]</parameterValue> <type> <name>Amazon.MTurk.Model.PolicyParameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentReviewPolicy_PolicyName</name> <description> <para> Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 </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="False" 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="False" position="Named"> <name>HITLayoutId</name> <description> <para> The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId parameter must be provided. </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="False" position="Named"> <name>HITLayoutParameter</name> <description> <para> If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.HITLayoutParameter[]</parameterValue> <type> <name>Amazon.MTurk.Model.HITLayoutParameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITReviewPolicy_Parameter</name> <description> <para>Name of the parameter from the Review policy. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.Model.PolicyParameter[]</parameterValue> <type> <name>Amazon.MTurk.Model.PolicyParameter[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITReviewPolicy_PolicyName</name> <description> <para> Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 </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 (ByValue, )" position="1"> <name>HITTypeId</name> <description> <para>The HIT type ID you want to create this HIT with. </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="False" position="Named"> <name>LifetimeInSecond</name> <description> <para> An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxAssignment</name> <description> <para> The number of times the HIT can be accepted and completed before the HIT becomes unavailable. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Question</name> <description> <para> The data the person completing the HIT uses to produce the results. Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId parameter must be provided. </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="False" position="Named"> <name>RequesterAnnotation</name> <description> <para> An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester. The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped. </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="False" position="Named"> <name>UniqueRequestToken</name> <description> <para> A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs. </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.MTurk.Model.HIT</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a HIT object. The service call response (type Amazon.MTurk.Model.CreateHITWithHITTypeResponse) 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=New-MTRHITWithHITType.html&tocid=New-MTRHITWithHITType</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>New-MTRQualificationType</name> <description> <para>Invokes the CreateQualificationType operation against Amazon MTurk Service.</para> </description> <verb>New</verb> <noun>MTRQualificationType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>CreateQualificationType</code> operation creates a new Qualification type, which is represented by a <code>QualificationType</code> data structure. </para> </description> <syntax> <syntaxItem> <name>New-MTRQualificationType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnswerKey</name> <description> <para>The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure. Constraints: Must not be longer than 65535 bytes. Constraints: None. If not specified, you must process Qualification requests manually. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoGranted</name> <description> <para>Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Constraints: If the Test parameter is specified, this parameter cannot be true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoGrantedValue</name> <description> <para>The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Keyword</name> <description> <para>One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Name</name> <description> <para> The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationTypeStatus</name> <description> <para>The initial status of the Qualification type. Constraints: Valid values are: Active | Inactive </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.QualificationTypeStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetryDelayInSecond</name> <description> <para>The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request. Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Test</name> <description> <para> The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, <code>TestDurationInSeconds</code> must also be specified. Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true. Constraints: None. If not specified, the Worker may request the Qualification without answering any questions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TestDurationInSecond</name> <description> <para>The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnswerKey</name> <description> <para>The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure. Constraints: Must not be longer than 65535 bytes. Constraints: None. If not specified, you must process Qualification requests manually. </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="False" position="Named"> <name>AutoGranted</name> <description> <para>Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Constraints: If the Test parameter is specified, this parameter cannot be true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoGrantedValue</name> <description> <para>The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type. </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="False" 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="False" position="Named"> <name>Keyword</name> <description> <para>One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search. </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="False" position="Named"> <name>Name</name> <description> <para> The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types. </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="False" position="Named"> <name>QualificationTypeStatus</name> <description> <para>The initial status of the Qualification type. Constraints: Valid values are: Active | Inactive </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.QualificationTypeStatus</parameterValue> <type> <name>Amazon.MTurk.QualificationTypeStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetryDelayInSecond</name> <description> <para>The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request. Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Test</name> <description> <para> The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, <code>TestDurationInSeconds</code> must also be specified. Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true. Constraints: None. If not specified, the Worker may request the Qualification without answering any questions. </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="False" position="Named"> <name>TestDurationInSecond</name> <description> <para>The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MTurk.Model.QualificationType</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a QualificationType object. The service call response (type Amazon.MTurk.Model.CreateQualificationTypeResponse) 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=New-MTRQualificationType.html&tocid=New-MTRQualificationType</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>New-MTRWorkerBlock</name> <description> <para>Invokes the CreateWorkerBlock operation against Amazon MTurk Service.</para> </description> <verb>New</verb> <noun>MTRWorkerBlock</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>CreateWorkerBlock</code> operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers. </para> </description> <syntax> <syntaxItem> <name>New-MTRWorkerBlock</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker to block. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Reason</name> <description> <para>A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Reason</name> <description> <para>A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message. </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 (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker to block. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the WorkerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.CreateWorkerBlockResponse) 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=New-MTRWorkerBlock.html&tocid=New-MTRWorkerBlock</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-MTRHIT</name> <description> <para>Invokes the DeleteHIT operation against Amazon MTurk Service.</para> </description> <verb>Remove</verb> <noun>MTRHIT</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>DeleteHIT</code> operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it. You can only dispose of HITs that are in the <code>Reviewable</code> state, with all of their submitted assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in the <code>Reviewable</code> state (for example, that has not expired, or still has active assignments), or on a HIT that is Reviewable but without all of its submitted assignments already approved or rejected, the service will return an error. - HITs are automatically disposed of after 120 days. - After you dispose of a HIT, you can no longer approve the HIT's rejected assignments. - Disposed HITs are not returned in results for the ListHITs operation. - Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs. </para> </description> <syntax> <syntaxItem> <name>Remove-MTRHIT</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HITId</name> <description> <para>The ID of the HIT to be deleted. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HITId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>HITId</name> <description> <para>The ID of the HIT to be deleted. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HITId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the HITId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.DeleteHITResponse) 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-MTRHIT.html&tocid=Remove-MTRHIT</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-MTRQualificationFromWorker</name> <description> <para>Invokes the DisassociateQualificationFromWorker operation against Amazon MTurk Service.</para> </description> <verb>Remove</verb> <noun>MTRQualificationFromWorker</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>DisassociateQualificationFromWorker</code> revokes a previously granted Qualification from a user. You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message. </para> </description> <syntax> <syntaxItem> <name>Remove-MTRQualificationFromWorker</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker who possesses the Qualification to be revoked. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the Qualification type of the Qualification to be revoked. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Reason</name> <description> <para>A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the Qualification type of the Qualification to be revoked. </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="False" position="Named"> <name>Reason</name> <description> <para>A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message. </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 (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker who possesses the Qualification to be revoked. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the WorkerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.DisassociateQualificationFromWorkerResponse) 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-MTRQualificationFromWorker.html&tocid=Remove-MTRQualificationFromWorker</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-MTRQualificationType</name> <description> <para>Invokes the DeleteQualificationType operation against Amazon MTurk Service.</para> </description> <verb>Remove</verb> <noun>MTRQualificationType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>DeleteQualificationType</code> deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types. DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType. </para> </description> <syntax> <syntaxItem> <name>Remove-MTRQualificationType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>QualificationTypeId</name> <description> <para>The ID of the QualificationType to dispose. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QualificationTypeId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the QualificationTypeId parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>QualificationTypeId</name> <description> <para>The ID of the QualificationType to dispose. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the QualificationTypeId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.DeleteQualificationTypeResponse) 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-MTRQualificationType.html&tocid=Remove-MTRQualificationType</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-MTRWorkerBlock</name> <description> <para>Invokes the DeleteWorkerBlock operation against Amazon MTurk Service.</para> </description> <verb>Remove</verb> <noun>MTRWorkerBlock</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>DeleteWorkerBlock</code> operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully. </para> </description> <syntax> <syntaxItem> <name>Remove-MTRWorkerBlock</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker to unblock. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Reason</name> <description> <para>A message that explains the reason for unblocking the Worker. The Worker does not see this message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Reason</name> <description> <para>A message that explains the reason for unblocking the Worker. The Worker does not see this message. </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 (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker to unblock. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the WorkerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.DeleteWorkerBlockResponse) 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-MTRWorkerBlock.html&tocid=Remove-MTRWorkerBlock</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-MTRBonus</name> <description> <para>Invokes the SendBonus operation against Amazon MTurk Service.</para> </description> <verb>Send</verb> <noun>MTRBonus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>SendBonus</code> operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees. </para> </description> <syntax> <syntaxItem> <name>Send-MTRBonus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker being paid the bonus. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentId</name> <description> <para>The ID of the assignment for which this bonus is paid. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BonusAmount</name> <description> <para> The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Reason</name> <description> <para>A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UniqueRequestToken</name> <description> <para>A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AssignmentId</name> <description> <para>The ID of the assignment for which this bonus is paid. </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="False" position="Named"> <name>BonusAmount</name> <description> <para> The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes. </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="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the WorkerId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Reason</name> <description> <para>A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message. </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="False" position="Named"> <name>UniqueRequestToken</name> <description> <para>A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID. </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 (ByValue, )" position="1"> <name>WorkerId</name> <description> <para>The ID of the Worker being paid the bonus. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the WorkerId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.SendBonusResponse) 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-MTRBonus.html&tocid=Send-MTRBonus</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-MTRTestEventNotification</name> <description> <para>Invokes the SendTestEventNotification operation against Amazon MTurk Service.</para> </description> <verb>Send</verb> <noun>MTRTestEventNotification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>SendTestEventNotification</code> operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them using the website. When you call this operation, the service attempts to send the test notification immediately. </para> </description> <syntax> <syntaxItem> <name>Send-MTRTestEventNotification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Destination</name> <description> <para> The target for notification messages. The Destination’s format is determined by the specified Transport: - When Transport is Email, the Destination is your email address. - When Transport is SQS, the Destination is your queue URL. - When Transport is SNS, the Destination is the ARN of your topic. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_EventType</name> <description> <para> The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TestEventType</name> <description> <para> The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.EventType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Transport</name> <description> <para> The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.NotificationTransport</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Version</name> <description> <para>The version of the Notification API to use. Valid value is 2006-05-05. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Destination</name> <description> <para> The target for notification messages. The Destination’s format is determined by the specified Transport: - When Transport is Email, the Destination is your email address. - When Transport is SQS, the Destination is your queue URL. - When Transport is SNS, the Destination is the ARN of your topic. </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="False" position="Named"> <name>Notification_EventType</name> <description> <para> The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation. </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="False" position="Named"> <name>Notification_Transport</name> <description> <para> The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.NotificationTransport</parameterValue> <type> <name>Amazon.MTurk.NotificationTransport</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Version</name> <description> <para>The version of the Notification API to use. Valid value is 2006-05-05. </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="False" position="Named"> <name>TestEventType</name> <description> <para> The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.EventType</parameterValue> <type> <name>Amazon.MTurk.EventType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.MTurk.Model.SendTestEventNotificationResponse) 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-MTRTestEventNotification.html&tocid=Send-MTRTestEventNotification</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-MTRWorkerNotification</name> <description> <para>Invokes the NotifyWorkers operation against Amazon MTurk Service.</para> </description> <verb>Send</verb> <noun>MTRWorkerNotification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>NotifyWorkers</code> operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker. </para> </description> <syntax> <syntaxItem> <name>Send-MTRWorkerNotification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MessageText</name> <description> <para>The text of the email message to send. Can include up to 4,096 characters </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Subject</name> <description> <para>The subject line of the email message to send. Can include up to 200 characters. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>WorkerId</name> <description> <para>A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>MessageText</name> <description> <para>The text of the email message to send. Can include up to 4,096 characters </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="False" position="Named"> <name>Subject</name> <description> <para>The subject line of the email message to send. Can include up to 200 characters. </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="False" position="Named"> <name>WorkerId</name> <description> <para>A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time. </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.MTurk.Model.NotifyWorkersFailureStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of NotifyWorkersFailureStatus objects. The service call response (type Amazon.MTurk.Model.NotifyWorkersResponse) 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=Send-MTRWorkerNotification.html&tocid=Send-MTRWorkerNotification</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>Update-MTRExpirationForHIT</name> <description> <para>Invokes the UpdateExpirationForHIT operation against Amazon MTurk Service.</para> </description> <verb>Update</verb> <noun>MTRExpirationForHIT</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>UpdateExpirationForHIT</code> operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately expired. </para> </description> <syntax> <syntaxItem> <name>Update-MTRExpirationForHIT</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExpireAt</name> <description> <para> The date and time at which you want the HIT to expire </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITId</name> <description> <para> The HIT to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ExpireAt</name> <description> <para> The date and time at which you want the HIT to expire </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>HITId</name> <description> <para> The HIT to update. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.MTurk.Model.UpdateExpirationForHITResponse) 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=Update-MTRExpirationForHIT.html&tocid=Update-MTRExpirationForHIT</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>Update-MTRHITReviewStatus</name> <description> <para>Invokes the UpdateHITReviewStatus operation against Amazon MTurk Service.</para> </description> <verb>Update</verb> <noun>MTRHITReviewStatus</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>UpdateHITReviewStatus</code> operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status. </para> </description> <syntax> <syntaxItem> <name>Update-MTRHITReviewStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITId</name> <description> <para> The ID of the HIT to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Revert</name> <description> <para> Specifies how to update the HIT status. Default is <code>False</code>. - Setting this to false will only transition a HIT from <code>Reviewable</code> to <code>Reviewing</code> - Setting this to true will only transition a HIT from <code>Reviewing</code> to <code>Reviewable</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>HITId</name> <description> <para> The ID of the HIT to update. </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="False" position="Named"> <name>Revert</name> <description> <para> Specifies how to update the HIT status. Default is <code>False</code>. - Setting this to false will only transition a HIT from <code>Reviewable</code> to <code>Reviewing</code> - Setting this to true will only transition a HIT from <code>Reviewing</code> to <code>Reviewable</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.MTurk.Model.UpdateHITReviewStatusResponse) 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=Update-MTRHITReviewStatus.html&tocid=Update-MTRHITReviewStatus</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>Update-MTRHITTypeOfHIT</name> <description> <para>Invokes the UpdateHITTypeOfHIT operation against Amazon MTurk Service.</para> </description> <verb>Update</verb> <noun>MTRHITTypeOfHIT</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>UpdateHITTypeOfHIT</code> operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones. </para> </description> <syntax> <syntaxItem> <name>Update-MTRHITTypeOfHIT</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>HITId</name> <description> <para>The HIT to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITTypeId</name> <description> <para>The ID of the new HIT type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HITId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>HITId</name> <description> <para>The HIT to update. </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="False" position="Named"> <name>HITTypeId</name> <description> <para>The ID of the new HIT type. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the HITId parameter. By default, this cmdlet does not generate any output. </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> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the HITId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MTurk.Model.UpdateHITTypeOfHITResponse) 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=Update-MTRHITTypeOfHIT.html&tocid=Update-MTRHITTypeOfHIT</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>Update-MTRNotificationSetting</name> <description> <para>Invokes the UpdateNotificationSettings operation against Amazon MTurk Service.</para> </description> <verb>Update</verb> <noun>MTRNotificationSetting</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>UpdateNotificationSettings</code> operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one. You can call the UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself by providing updates to the Active status without specifying a new notification specification. To change the Active status of a HIT type's notifications, the HIT type must already have a notification specification, or one must be provided in the same call to <code>UpdateNotificationSettings</code>. </para> </description> <syntax> <syntaxItem> <name>Update-MTRNotificationSetting</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Active</name> <description> <para> Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. You must specify either the Notification parameter or the Active parameter for the call to UpdateNotificationSettings to succeed. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Destination</name> <description> <para> The target for notification messages. The Destination’s format is determined by the specified Transport: - When Transport is Email, the Destination is your email address. - When Transport is SQS, the Destination is your queue URL. - When Transport is SNS, the Destination is the ARN of your topic. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_EventType</name> <description> <para> The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>HITTypeId</name> <description> <para> The ID of the HIT type whose notification specification is being updated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Transport</name> <description> <para> The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.NotificationTransport</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Version</name> <description> <para>The version of the Notification API to use. Valid value is 2006-05-05. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Active</name> <description> <para> Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. You must specify either the Notification parameter or the Active parameter for the call to UpdateNotificationSettings to succeed. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>HITTypeId</name> <description> <para> The ID of the HIT type whose notification specification is being updated. </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="False" position="Named"> <name>Notification_Destination</name> <description> <para> The target for notification messages. The Destination’s format is determined by the specified Transport: - When Transport is Email, the Destination is your email address. - When Transport is SQS, the Destination is your queue URL. - When Transport is SNS, the Destination is the ARN of your topic. </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="False" position="Named"> <name>Notification_EventType</name> <description> <para> The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation. </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="False" position="Named"> <name>Notification_Transport</name> <description> <para> The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.NotificationTransport</parameterValue> <type> <name>Amazon.MTurk.NotificationTransport</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Notification_Version</name> <description> <para>The version of the Notification API to use. Valid value is 2006-05-05. </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</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output. The service response (type Amazon.MTurk.Model.UpdateNotificationSettingsResponse) 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=Update-MTRNotificationSetting.html&tocid=Update-MTRNotificationSetting</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>Update-MTRQualificationType</name> <description> <para>Invokes the UpdateQualificationType operation against Amazon MTurk Service.</para> </description> <verb>Update</verb> <noun>MTRQualificationType</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>The <code>UpdateQualificationType</code> operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes. Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries. You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key. If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test. If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values. If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually. You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type. </para> </description> <syntax> <syntaxItem> <name>Update-MTRQualificationType</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnswerKey</name> <description> <para>The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoGranted</name> <description> <para>Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Constraints: If the Test parameter is specified, this parameter cannot be true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoGrantedValue</name> <description> <para>The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The new description of the Qualification type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the Qualification type to update. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>QualificationTypeStatus</name> <description> <para>The new status of the Qualification type - Active | Inactive </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.QualificationTypeStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetryDelayInSecond</name> <description> <para>The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Test</name> <description> <para>The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, <code>TestDurationInSeconds</code> must also be specified. Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true. Constraints: None. If not specified, the Worker may request the Qualification without answering any questions. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>TestDurationInSecond</name> <description> <para>The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AnswerKey</name> <description> <para>The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure. </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="False" position="Named"> <name>AutoGranted</name> <description> <para>Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Constraints: If the Test parameter is specified, this parameter cannot be true. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>AutoGrantedValue</name> <description> <para>The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Description</name> <description> <para>The new description of the Qualification type. </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="False" 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="False" position="Named"> <name>QualificationTypeId</name> <description> <para>The ID of the Qualification type to update. </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="False" position="Named"> <name>QualificationTypeStatus</name> <description> <para>The new status of the Qualification type - Active | Inactive </para> </description> <parameterValue required="true" variableLength="false">Amazon.MTurk.QualificationTypeStatus</parameterValue> <type> <name>Amazon.MTurk.QualificationTypeStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RetryDelayInSecond</name> <description> <para>The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Test</name> <description> <para>The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, <code>TestDurationInSeconds</code> must also be specified. Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true. Constraints: None. If not specified, the Worker may request the Qualification without answering any questions. </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="False" position="Named"> <name>TestDurationInSecond</name> <description> <para>The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification. </para> </description> <parameterValue required="true" variableLength="false">System.Int64</parameterValue> <type> <name>System.Int64</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MTurk.Model.QualificationType</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a QualificationType object. The service call response (type Amazon.MTurk.Model.UpdateQualificationTypeResponse) 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=Update-MTRQualificationType.html&tocid=Update-MTRQualificationType</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>Add-MHCreatedArtifact</name> <description> <para>Invokes the AssociateCreatedArtifact operation against AWS Migration Hub.</para> </description> <verb>Add</verb> <noun>MHCreatedArtifact</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits: - Migration tools can call the <code>AssociateCreatedArtifact</code> operation to indicate which AWS artifact is associated with a migration task. - The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: <code>arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b</code>. - Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc. </para> </description> <syntax> <syntaxItem> <name>Add-MHCreatedArtifact</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreatedArtifact</name> <description> <para>An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.Model.CreatedArtifact</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the CreatedArtifact parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreatedArtifact</name> <description> <para>An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.Model.CreatedArtifact</parameterValue> <type> <name>Amazon.MigrationHub.Model.CreatedArtifact</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the CreatedArtifact parameter. By default, this cmdlet does not generate any output. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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.MigrationHub.Model.CreatedArtifact</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the CreatedArtifact parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.AssociateCreatedArtifactResponse) 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=Add-MHCreatedArtifact.html&tocid=Add-MHCreatedArtifact</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Add-MHDiscoveredResource</name> <description> <para>Invokes the AssociateDiscoveredResource operation against AWS Migration Hub.</para> </description> <verb>Add</verb> <noun>MHDiscoveredResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task. </para> </description> <syntax> <syntaxItem> <name>Add-MHDiscoveredResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DiscoveredResource</name> <description> <para>Object representing a Resource. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.Model.DiscoveredResource</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MigrationTaskName</name> <description> <para>The identifier given to the MigrationTask. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DiscoveredResource parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>DiscoveredResource</name> <description> <para>Object representing a Resource. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.Model.DiscoveredResource</parameterValue> <type> <name>Amazon.MigrationHub.Model.DiscoveredResource</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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>MigrationTaskName</name> <description> <para>The identifier given to the MigrationTask. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the DiscoveredResource parameter. By default, this cmdlet does not generate any output. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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.MigrationHub.Model.DiscoveredResource</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the DiscoveredResource parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.AssociateDiscoveredResourceResponse) 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=Add-MHDiscoveredResource.html&tocid=Add-MHDiscoveredResource</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Get-MHApplicationState</name> <description> <para>Invokes the DescribeApplicationState operation against AWS Migration Hub.</para> </description> <verb>Get</verb> <noun>MHApplicationState</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets the migration status of an application. </para> </description> <syntax> <syntaxItem> <name>Get-MHApplicationState</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ApplicationId</name> <description> <para>The configurationId in ADS that uniquely identifies the grouped application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ApplicationId</name> <description> <para>The configurationId in ADS that uniquely identifies the grouped application. </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.MigrationHub.Model.DescribeApplicationStateResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MigrationHub.Model.DescribeApplicationStateResponse 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-MHApplicationState.html&tocid=Get-MHApplicationState</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Get-MHCreatedArtifactList</name> <description> <para>Invokes the ListCreatedArtifacts operation against AWS Migration Hub.</para> </description> <verb>Get</verb> <noun>MHCreatedArtifactList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits: - Gets the list of the created artifacts while migration is taking place. - Shows the artifacts created by the migration tool that was associated by the <code>AssociateCreatedArtifact</code> API. - Lists created artifacts in a paginated interface. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MHCreatedArtifactList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Maximum number of results to be returned per page. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Maximum number of results to be returned per page. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </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="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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.MigrationHub.Model.CreatedArtifact</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of CreatedArtifact objects. The service call response (type Amazon.MigrationHub.Model.ListCreatedArtifactsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MHCreatedArtifactList.html&tocid=Get-MHCreatedArtifactList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Get-MHDiscoveredResourceList</name> <description> <para>Invokes the ListDiscoveredResources operation against AWS Migration Hub.</para> </description> <verb>Get</verb> <noun>MHDiscoveredResourceList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists discovered resources associated with the given <code>MigrationTask</code>.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MHDiscoveredResourceList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>The name of the MigrationTask. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results returned per page. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of results returned per page. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>The name of the MigrationTask. </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="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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.MigrationHub.Model.DiscoveredResource</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DiscoveredResource objects. The service call response (type Amazon.MigrationHub.Model.ListDiscoveredResourcesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MHDiscoveredResourceList.html&tocid=Get-MHDiscoveredResourceList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Get-MHMigrationTask</name> <description> <para>Invokes the DescribeMigrationTask operation against AWS Migration Hub.</para> </description> <verb>Get</verb> <noun>MHMigrationTask</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Retrieves a list of all attributes associated with a specific migration task. </para> </description> <syntax> <syntaxItem> <name>Get-MHMigrationTask</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>The identifier given to the MigrationTask. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>The identifier given to the MigrationTask. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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.MigrationHub.Model.MigrationTask</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a MigrationTask object. The service call response (type Amazon.MigrationHub.Model.DescribeMigrationTaskResponse) 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-MHMigrationTask.html&tocid=Get-MHMigrationTask</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Get-MHMigrationTaskList</name> <description> <para>Invokes the ListMigrationTasks operation against AWS Migration Hub.</para> </description> <verb>Get</verb> <noun>MHMigrationTaskList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits: - Can show a summary list of the most recent migration tasks. - Can show a summary list of migration tasks associated with a given discovered resource. - Lists migration tasks in a paginated interface. <br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MHMigrationTaskList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceName</name> <description> <para>Filter migration tasks by discovered resource name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Value to specify how many results are returned per page. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Value to specify how many results are returned per page. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ResourceName</name> <description> <para>Filter migration tasks by discovered resource name. </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.MigrationHub.Model.MigrationTaskSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of MigrationTaskSummary objects. The service call response (type Amazon.MigrationHub.Model.ListMigrationTasksResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MHMigrationTaskList.html&tocid=Get-MHMigrationTaskList</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Get-MHProgressUpdateStream</name> <description> <para>Invokes the ListProgressUpdateStreams operation against AWS Migration Hub.</para> </description> <verb>Get</verb> <noun>MHProgressUpdateStream</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Lists progress update streams associated with the user account making this call.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MHProgressUpdateStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Filter to limit the maximum number of results to list per page. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Filter to limit the maximum number of results to list per page. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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.MigrationHub.Model.ProgressUpdateStreamSummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of ProgressUpdateStreamSummary objects. The service call response (type Amazon.MigrationHub.Model.ListProgressUpdateStreamsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MHProgressUpdateStream.html&tocid=Get-MHProgressUpdateStream</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Import-MHMigrationTask</name> <description> <para>Invokes the ImportMigrationTask operation against AWS Migration Hub.</para> </description> <verb>Import</verb> <noun>MHMigrationTask</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool. This API is a prerequisite to calling the <code>NotifyMigrationTaskState</code> API as the migration tool must first register the migration task with Migration Hub. </para> </description> <syntax> <syntaxItem> <name>Import-MHMigrationTask</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the MigrationTaskName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the MigrationTaskName parameter. By default, this cmdlet does not generate any output. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the MigrationTaskName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.ImportMigrationTaskResponse) 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=Import-MHMigrationTask.html&tocid=Import-MHMigrationTask</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>New-MHProgressUpdateStream</name> <description> <para>Invokes the CreateProgressUpdateStream operation against AWS Migration Hub.</para> </description> <verb>New</verb> <noun>MHProgressUpdateStream</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account. </para> </description> <syntax> <syntaxItem> <name>New-MHProgressUpdateStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProgressUpdateStreamName</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProgressUpdateStreamName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProgressUpdateStreamName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ProgressUpdateStreamName</name> <description> <para>The name of the ProgressUpdateStream. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ProgressUpdateStreamName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.CreateProgressUpdateStreamResponse) 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=New-MHProgressUpdateStream.html&tocid=New-MHProgressUpdateStream</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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-MHCreatedArtifact</name> <description> <para>Invokes the DisassociateCreatedArtifact operation against AWS Migration Hub.</para> </description> <verb>Remove</verb> <noun>MHCreatedArtifact</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits: - A migration user can call the <code>DisassociateCreatedArtifacts</code> operation to disassociate a created AWS Artifact from a migration task. - The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: <code>arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b</code>. - Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc. </para> </description> <syntax> <syntaxItem> <name>Remove-MHCreatedArtifact</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreatedArtifactName</name> <description> <para>An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task to be disassociated with the artifact. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the CreatedArtifactName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>CreatedArtifactName</name> <description> <para>An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) </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="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task to be disassociated with the artifact. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the CreatedArtifactName parameter. By default, this cmdlet does not generate any output. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the CreatedArtifactName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.DisassociateCreatedArtifactResponse) 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-MHCreatedArtifact.html&tocid=Remove-MHCreatedArtifact</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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-MHDiscoveredResource</name> <description> <para>Invokes the DisassociateDiscoveredResource operation against AWS Migration Hub.</para> </description> <verb>Remove</verb> <noun>MHDiscoveredResource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociate an Application Discovery Service (ADS) discovered resource from a migration task. </para> </description> <syntax> <syntaxItem> <name>Remove-MHDiscoveredResource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationId</name> <description> <para>ConfigurationId of the ADS resource to be disassociated. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MigrationTaskName</name> <description> <para>The identifier given to the MigrationTask. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ConfigurationId</name> <description> <para>ConfigurationId of the ADS resource to be disassociated. </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="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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>MigrationTaskName</name> <description> <para>The identifier given to the MigrationTask. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ConfigurationId parameter. By default, this cmdlet does not generate any output. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ConfigurationId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.DisassociateDiscoveredResourceResponse) 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-MHDiscoveredResource.html&tocid=Remove-MHDiscoveredResource</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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-MHProgressUpdateStream</name> <description> <para>Invokes the DeleteProgressUpdateStream operation against AWS Migration Hub.</para> </description> <verb>Remove</verb> <noun>MHProgressUpdateStream</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits: - The only parameter needed for <code>DeleteProgressUpdateStream</code> is the stream name (same as a <code>CreateProgressUpdateStream</code> call). - The call will return, and a background process will asynchronously be doing the actual delete of the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts). - If the stream takes time to be deleted, it might still show up on a <code>ListProgressUpdateStreams</code> call. - <code>CreateProgressUpdateStream</code>, <code>ImportMigrationTask</code>, <code>NotifyMigrationTaskState</code>, and all Associate[*] APIs realted to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted. - Once the stream and all of its resources are deleted, <code>CreateProgressUpdateStream</code> for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream). </para> </description> <syntax> <syntaxItem> <name>Remove-MHProgressUpdateStream</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProgressUpdateStreamName</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProgressUpdateStreamName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ProgressUpdateStreamName parameter. By default, this cmdlet does not generate any output. </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 (ByValue, )" position="1"> <name>ProgressUpdateStreamName</name> <description> <para>The name of the ProgressUpdateStream. </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 System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ProgressUpdateStreamName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.DeleteProgressUpdateStreamResponse) 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-MHProgressUpdateStream.html&tocid=Remove-MHProgressUpdateStream</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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-MHApplicationStateNotification</name> <description> <para>Invokes the NotifyApplicationState operation against AWS Migration Hub.</para> </description> <verb>Send</verb> <noun>MHApplicationStateNotification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the migration state of an application. For a given application identified by the value passed to <code>ApplicationId</code>, its status is set or updated by passing one of three values to <code>Status</code>: <code>NOT_STARTED | IN_PROGRESS | COMPLETED</code>. </para> </description> <syntax> <syntaxItem> <name>Send-MHApplicationStateNotification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ApplicationId</name> <description> <para>The configurationId in ADS that uniquely identifies the grouped application. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Status</name> <description> <para>Status of the application - Not Started, In-Progress, Complete. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.ApplicationStatus</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ApplicationId parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ApplicationId</name> <description> <para>The configurationId in ADS that uniquely identifies the grouped application. </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="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the ApplicationId parameter. By default, this cmdlet does not generate any output. </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="False" position="Named"> <name>Status</name> <description> <para>Status of the application - Not Started, In-Progress, Complete. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.ApplicationStatus</parameterValue> <type> <name>Amazon.MigrationHub.ApplicationStatus</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the ApplicationId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.NotifyApplicationStateResponse) 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-MHApplicationStateNotification.html&tocid=Send-MHApplicationStateNotification</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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-MHMigrationTaskStateNotification</name> <description> <para>Invokes the NotifyMigrationTaskState operation against AWS Migration Hub.</para> </description> <verb>Send</verb> <noun>MHMigrationTaskStateNotification</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits: - Migration tools will call the <code>NotifyMigrationTaskState</code> API to share the latest progress and status. - <code>MigrationTaskName</code> is used for addressing updates to the correct target. - <code>ProgressUpdateStream</code> is used for access control and to provide a namespace for each migration tool. </para> </description> <syntax> <syntaxItem> <name>Send-MHMigrationTaskStateNotification</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Task</name> <description> <para>Information about the task's progress and status. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.Model.Task</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextUpdateSecond</name> <description> <para>Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpdateDateTime</name> <description> <para>The timestamp when the task was gathered. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Task parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </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="False" position="Named"> <name>NextUpdateSecond</name> <description> <para>Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the Task parameter. By default, this cmdlet does not generate any output. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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 (ByValue, )" position="1"> <name>Task</name> <description> <para>Information about the task's progress and status. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.Model.Task</parameterValue> <type> <name>Amazon.MigrationHub.Model.Task</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>UpdateDateTime</name> <description> <para>The timestamp when the task was gathered. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> <type> <name>System.DateTime</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.MigrationHub.Model.Task</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the Task parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.NotifyMigrationTaskStateResponse) 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-MHMigrationTaskStateNotification.html&tocid=Send-MHMigrationTaskStateNotification</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Set-MHResourceAttribute</name> <description> <para>Invokes the PutResourceAttributes operation against AWS Migration Hub.</para> </description> <verb>Set</verb> <noun>MHResourceAttribute</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after <code>PutResourceAttributes</code> returns. <important><para> Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to <i>add</i> an IP address, it will then be required to call it with <i>both</i> the IP and MAC addresses to prevent overiding the MAC address. </para></important> Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call <code>ListAssociatedResource</code>. </para> </description> <syntax> <syntaxItem> <name>Set-MHResourceAttribute</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceAttributeList</name> <description> <para>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.Model.ResourceAttribute[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the MigrationTaskName parameter. By default, this cmdlet does not generate any output. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DryRun</name> <description> <para>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, ByPropertyName)" position="1"> <name>MigrationTaskName</name> <description> <para>Unique identifier that references the migration task. </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="False" position="Named"> <name>PassThru</name> <description> <para>Returns the value passed to the MigrationTaskName parameter. By default, this cmdlet does not generate any output. </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>ProgressUpdateStream</name> <description> <para>The name of the ProgressUpdateStream. </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="False" position="Named"> <name>ResourceAttributeList</name> <description> <para>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MigrationHub.Model.ResourceAttribute[]</parameterValue> <type> <name>Amazon.MigrationHub.Model.ResourceAttribute[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or System.String</name> <uri /> <description /> </type> <description> <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the MigrationTaskName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.MigrationHub.Model.PutResourceAttributesResponse) 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=Set-MHResourceAttribute.html&tocid=Set-MHResourceAttribute</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> <navigationLink> <linkText>User Guide:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/migrationhub/latest/ug/api-reference.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>Get-MESEntitlementList</name> <description> <para>Invokes the GetEntitlements operation against AWS Marketplace Entitlement Service.</para> </description> <verb>Get</verb> <noun>MESEntitlementList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MESEntitlementList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ProductCode</name> <description> <para>Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are <i>unioned</i> for each value in the value list, and then <i>intersected</i> for each filter key. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Filter</name> <description> <para>Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are <i>unioned</i> for each value in the value list, and then <i>intersected</i> for each filter key. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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 (ByValue, )" position="1"> <name>ProductCode</name> <description> <para>Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created. </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.MarketplaceEntitlementService.Model.Entitlement</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Entitlement objects. The service call response (type Amazon.MarketplaceEntitlementService.Model.GetEntitlementsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MESEntitlementList.html&tocid=Get-MESEntitlementList</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>Add-MLResourceTag</name> <description> <para>Invokes the AddTags operation against Amazon Machine Learning.</para> </description> <verb>Add</verb> <noun>MLResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, <code>AddTags</code> updates the tag's value. </para> </description> <syntax> <syntaxItem> <name>Add-MLResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the ML object to tag. For example, <code>exampleModelId</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the ML object to tag. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.TaggableResourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" 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 (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the ML object to tag. For example, <code>exampleModelId</code>. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the ML object to tag. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.TaggableResourceType</parameterValue> <type> <name>Amazon.MachineLearning.TaggableResourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Tag</name> <description> <para>The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.Model.Tag[]</parameterValue> <type> <name>Amazon.MachineLearning.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.AddTagsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MachineLearning.Model.AddTagsResponse 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=Add-MLResourceTag.html&tocid=Add-MLResourceTag</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</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>Get-MLBatchPrediction</name> <description> <para>Invokes the GetBatchPrediction operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLBatchPrediction</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a <code>BatchPrediction</code> that includes detailed metadata, status, and data file information for a <code>Batch Prediction</code> request. </para> </description> <syntax> <syntaxItem> <name>Get-MLBatchPrediction</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>BatchPredictionId</name> <description> <para>An ID assigned to the <code>BatchPrediction</code> at creation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>BatchPredictionId</name> <description> <para>An ID assigned to the <code>BatchPrediction</code> at creation. </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.MachineLearning.Model.GetBatchPredictionResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MachineLearning.Model.GetBatchPredictionResponse 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-MLBatchPrediction.html&tocid=Get-MLBatchPrediction</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLBatchPrediction -BatchPredictionId ID</code><remarks><para>Description</para><para>-----------</para><para>Returns the detailed metadata for a batch prediction with id ID.</para><para /><para /></remarks> </example> </examples> </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>Get-MLBatchPredictionList</name> <description> <para>Invokes the DescribeBatchPredictions operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLBatchPredictionList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of <code>BatchPrediction</code> operations that match the search criteria in the request.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MLBatchPredictionList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EQ</name> <description> <para>The equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FilterVariable</name> <description> <para>Use one of the following variables to filter a list of <code>BatchPrediction</code>: -<code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date. -<code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status. -<code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code><b></b><code>Name</code>. -<code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation. -<code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>. -<code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>. -<code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.BatchPredictionFilterVariable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GE</name> <description> <para>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GT</name> <description> <para>The greater than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LE</name> <description> <para>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LT</name> <description> <para>The less than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NE</name> <description> <para>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Prefix</name> <description> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, a <code>Batch Prediction</code> operation could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: - 2014-09 - 2014-09-09 - 2014-09-09-Holiday </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortOrder</name> <description> <para>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s. -<code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). -<code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). Results are sorted by <code>FilterVariable</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.SortOrder</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>An ID of the page in the paginated results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EQ</name> <description> <para>The equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>. </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="False" position="Named"> <name>FilterVariable</name> <description> <para>Use one of the following variables to filter a list of <code>BatchPrediction</code>: -<code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date. -<code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status. -<code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code><b></b><code>Name</code>. -<code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation. -<code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>. -<code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>. -<code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.BatchPredictionFilterVariable</parameterValue> <type> <name>Amazon.MachineLearning.BatchPredictionFilterVariable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GE</name> <description> <para>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </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="False" position="Named"> <name>GT</name> <description> <para>The greater than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>. </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="False" position="Named"> <name>LE</name> <description> <para>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>. </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="False" position="Named"> <name>Limit</name> <description> <para>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LT</name> <description> <para>The less than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>. </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="False" position="Named"> <name>NE</name> <description> <para>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>. </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="False" position="Named"> <name>NextToken</name> <description> <para>An ID of the page in the paginated results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Prefix</name> <description> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, a <code>Batch Prediction</code> operation could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: - 2014-09 - 2014-09-09 - 2014-09-09-Holiday </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="False" position="Named"> <name>SortOrder</name> <description> <para>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s. -<code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). -<code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). Results are sorted by <code>FilterVariable</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.SortOrder</parameterValue> <type> <name>Amazon.MachineLearning.SortOrder</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.BatchPrediction</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of BatchPrediction objects. The service call response (type Amazon.MachineLearning.Model.DescribeBatchPredictionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MLBatchPredictionList.html&tocid=Get-MLBatchPredictionList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLBatchPredictionList</code><remarks><para>Description</para><para>-----------</para><para>Returns a list of all BatchPredictions and their associated data records that match the search criterion given in the request.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-MLBatchPredictionList -FilterVariable Status -EQ COMPLETED</code><remarks><para>Description</para><para>-----------</para><para>Returns a list of all BatchPredictions with a status of COMPLETED.</para><para /><para /></remarks> </example> </examples> </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>Get-MLDataSource</name> <description> <para>Invokes the GetDataSource operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLDataSource</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>. <code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. </para> </description> <syntax> <syntaxItem> <name>Get-MLDataSource</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DataSourceId</name> <description> <para>The ID assigned to the <code>DataSource</code> at creation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VerboseResponse</name> <description> <para>Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>. If true, <code>DataSourceSchema</code> is returned. If false, <code>DataSourceSchema</code> is not returned. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DataSourceId</name> <description> <para>The ID assigned to the <code>DataSource</code> at creation. </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="False" position="Named"> <name>VerboseResponse</name> <description> <para>Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>. If true, <code>DataSourceSchema</code> is returned. If false, <code>DataSourceSchema</code> is not returned. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.GetDataSourceResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MachineLearning.Model.GetDataSourceResponse 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-MLDataSource.html&tocid=Get-MLDataSource</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLDataSource -DataSourceId ID</code><remarks><para>Description</para><para>-----------</para><para>Returns the metadata, status, and data file information for a DataSource with the id ID</para><para /><para /></remarks> </example> </examples> </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>Get-MLDataSourceList</name> <description> <para>Invokes the DescribeDataSources operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLDataSourceList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of <code>DataSource</code> that match the search criteria in the request.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MLDataSourceList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EQ</name> <description> <para>The equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FilterVariable</name> <description> <para>Use one of the following variables to filter a list of <code>DataSource</code>: -<code>CreatedAt</code> - Sets the search criteria to <code>DataSource</code> creation dates. -<code>Status</code> - Sets the search criteria to <code>DataSource</code> statuses. -<code>Name</code> - Sets the search criteria to the contents of <code>DataSource</code><b></b><code>Name</code>. -<code>DataUri</code> - Sets the search criteria to the URI of data files used to create the <code>DataSource</code>. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory. -<code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>DataSource</code> creation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.DataSourceFilterVariable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GE</name> <description> <para>The greater than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GT</name> <description> <para>The greater than operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LE</name> <description> <para>The less than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LT</name> <description> <para>The less than operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NE</name> <description> <para>The not equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Prefix</name> <description> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, a <code>DataSource</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>DataSource</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: - 2014-09 - 2014-09-09 - 2014-09-09-Holiday </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortOrder</name> <description> <para>A two-value parameter that determines the sequence of the resulting list of <code>DataSource</code>. -<code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). -<code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). Results are sorted by <code>FilterVariable</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.SortOrder</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para> The maximum number of <code>DataSource</code> to include in the result. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The ID of the page in the paginated results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EQ</name> <description> <para>The equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>. </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="False" position="Named"> <name>FilterVariable</name> <description> <para>Use one of the following variables to filter a list of <code>DataSource</code>: -<code>CreatedAt</code> - Sets the search criteria to <code>DataSource</code> creation dates. -<code>Status</code> - Sets the search criteria to <code>DataSource</code> statuses. -<code>Name</code> - Sets the search criteria to the contents of <code>DataSource</code><b></b><code>Name</code>. -<code>DataUri</code> - Sets the search criteria to the URI of data files used to create the <code>DataSource</code>. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory. -<code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>DataSource</code> creation. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.DataSourceFilterVariable</parameterValue> <type> <name>Amazon.MachineLearning.DataSourceFilterVariable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GE</name> <description> <para>The greater than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </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="False" position="Named"> <name>GT</name> <description> <para>The greater than operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>. </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="False" position="Named"> <name>LE</name> <description> <para>The less than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>. </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="False" position="Named"> <name>Limit</name> <description> <para> The maximum number of <code>DataSource</code> to include in the result. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LT</name> <description> <para>The less than operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>. </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="False" position="Named"> <name>NE</name> <description> <para>The not equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>. </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="False" position="Named"> <name>NextToken</name> <description> <para>The ID of the page in the paginated results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Prefix</name> <description> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, a <code>DataSource</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>DataSource</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: - 2014-09 - 2014-09-09 - 2014-09-09-Holiday </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="False" position="Named"> <name>SortOrder</name> <description> <para>A two-value parameter that determines the sequence of the resulting list of <code>DataSource</code>. -<code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). -<code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). Results are sorted by <code>FilterVariable</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.SortOrder</parameterValue> <type> <name>Amazon.MachineLearning.SortOrder</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.DataSource</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of DataSource objects. The service call response (type Amazon.MachineLearning.Model.DescribeDataSourcesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MLDataSourceList.html&tocid=Get-MLDataSourceList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLDataSourceList</code><remarks><para>Description</para><para>-----------</para><para>Returns a list of all DataSources and their associated data records.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-MLDataDourceList -FilterVariable Status -EQ COMPLETED</code><remarks><para>Description</para><para>-----------</para><para>Returns a list of all DataSources with a status of COMPLETED.</para><para /><para /></remarks> </example> </examples> </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>Get-MLEvaluation</name> <description> <para>Invokes the GetEvaluation operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLEvaluation</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an <code>Evaluation</code> that includes metadata as well as the current status of the <code>Evaluation</code>. </para> </description> <syntax> <syntaxItem> <name>Get-MLEvaluation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>EvaluationId</name> <description> <para>The ID of the <code>Evaluation</code> to retrieve. The evaluation of each <code>MLModel</code> is recorded and cataloged. The ID provides the means to access the information. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>EvaluationId</name> <description> <para>The ID of the <code>Evaluation</code> to retrieve. The evaluation of each <code>MLModel</code> is recorded and cataloged. The ID provides the means to access the information. </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.MachineLearning.Model.GetEvaluationResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MachineLearning.Model.GetEvaluationResponse 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-MLEvaluation.html&tocid=Get-MLEvaluation</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLEvaluation -EvaluationId ID</code><remarks><para>Description</para><para>-----------</para><para>Returns metadata and status for an Evaluation with id ID.</para><para /><para /></remarks> </example> </examples> </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>Get-MLEvaluationList</name> <description> <para>Invokes the DescribeEvaluations operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLEvaluationList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of <code>DescribeEvaluations</code> that match the search criteria in the request.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MLEvaluationList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EQ</name> <description> <para>The equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FilterVariable</name> <description> <para>Use one of the following variable to filter a list of <code>Evaluation</code> objects: -<code>CreatedAt</code> - Sets the search criteria to the <code>Evaluation</code> creation date. -<code>Status</code> - Sets the search criteria to the <code>Evaluation</code> status. -<code>Name</code> - Sets the search criteria to the contents of <code>Evaluation</code><b></b><code>Name</code>. -<code>IAMUser</code> - Sets the search criteria to the user account that invoked an <code>Evaluation</code>. -<code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> that was evaluated. -<code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in <code>Evaluation</code>. -<code>DataUri</code> - Sets the search criteria to the data file(s) used in <code>Evaluation</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.EvaluationFilterVariable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GE</name> <description> <para>The greater than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GT</name> <description> <para>The greater than operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LE</name> <description> <para>The less than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LT</name> <description> <para>The less than operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NE</name> <description> <para>The not equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Prefix</name> <description> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, an <code>Evaluation</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>Evaluation</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: - 2014-09 - 2014-09-09 - 2014-09-09-Holiday </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortOrder</name> <description> <para>A two-value parameter that determines the sequence of the resulting list of <code>Evaluation</code>. -<code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). -<code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). Results are sorted by <code>FilterVariable</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.SortOrder</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para> The maximum number of <code>Evaluation</code> to include in the result. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The ID of the page in the paginated results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EQ</name> <description> <para>The equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>. </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="False" position="Named"> <name>FilterVariable</name> <description> <para>Use one of the following variable to filter a list of <code>Evaluation</code> objects: -<code>CreatedAt</code> - Sets the search criteria to the <code>Evaluation</code> creation date. -<code>Status</code> - Sets the search criteria to the <code>Evaluation</code> status. -<code>Name</code> - Sets the search criteria to the contents of <code>Evaluation</code><b></b><code>Name</code>. -<code>IAMUser</code> - Sets the search criteria to the user account that invoked an <code>Evaluation</code>. -<code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> that was evaluated. -<code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in <code>Evaluation</code>. -<code>DataUri</code> - Sets the search criteria to the data file(s) used in <code>Evaluation</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.EvaluationFilterVariable</parameterValue> <type> <name>Amazon.MachineLearning.EvaluationFilterVariable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GE</name> <description> <para>The greater than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </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="False" position="Named"> <name>GT</name> <description> <para>The greater than operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>. </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="False" position="Named"> <name>LE</name> <description> <para>The less than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>. </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="False" position="Named"> <name>Limit</name> <description> <para> The maximum number of <code>Evaluation</code> to include in the result. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LT</name> <description> <para>The less than operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>. </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="False" position="Named"> <name>NE</name> <description> <para>The not equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>. </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="False" position="Named"> <name>NextToken</name> <description> <para>The ID of the page in the paginated results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Prefix</name> <description> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, an <code>Evaluation</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>Evaluation</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: - 2014-09 - 2014-09-09 - 2014-09-09-Holiday </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="False" position="Named"> <name>SortOrder</name> <description> <para>A two-value parameter that determines the sequence of the resulting list of <code>Evaluation</code>. -<code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). -<code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). Results are sorted by <code>FilterVariable</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.SortOrder</parameterValue> <type> <name>Amazon.MachineLearning.SortOrder</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.Evaluation</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Evaluation objects. The service call response (type Amazon.MachineLearning.Model.DescribeEvaluationsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MLEvaluationList.html&tocid=Get-MLEvaluationList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLEvaluationList</code><remarks><para>Description</para><para>-----------</para><para>Returns a list of all Evaluation resources</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-MLEvaluationList -FilterVariable Status -EQ COMPLETED</code><remarks><para>Description</para><para>-----------</para><para>Returns a list of all Evaulations with a status of COMPLETED.</para><para /><para /></remarks> </example> </examples> </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>Get-MLModel</name> <description> <para>Invokes the GetMLModel operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLModel</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an <code>MLModel</code> that includes detailed metadata, data source information, and the current status of the <code>MLModel</code>. <code>GetMLModel</code> provides results in normal or verbose format. </para> </description> <syntax> <syntaxItem> <name>Get-MLModel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>MLModelId</name> <description> <para>The ID assigned to the <code>MLModel</code> at creation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>VerboseResponse</name> <description> <para>Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>. If true, <code>Recipe</code> is returned. If false, <code>Recipe</code> is not returned. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>MLModelId</name> <description> <para>The ID assigned to the <code>MLModel</code> at creation. </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="False" position="Named"> <name>VerboseResponse</name> <description> <para>Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>. If true, <code>Recipe</code> is returned. If false, <code>Recipe</code> is not returned. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.GetMLModelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MachineLearning.Model.GetMLModelResponse 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-MLModel.html&tocid=Get-MLModel</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLModel -ModelId ID</code><remarks><para>Description</para><para>-----------</para><para>Returns the detail metadata, status, schema, and data file information for a MLModel with id ID.</para><para /><para /></remarks> </example> </examples> </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>Get-MLModelList</name> <description> <para>Invokes the DescribeMLModels operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLModelList</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of <code>MLModel</code> that match the search criteria in the request.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para> </description> <syntax> <syntaxItem> <name>Get-MLModelList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EQ</name> <description> <para>The equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>FilterVariable</name> <description> <para>Use one of the following variables to filter a list of <code>MLModel</code>: -<code>CreatedAt</code> - Sets the search criteria to <code>MLModel</code> creation date. -<code>Status</code> - Sets the search criteria to <code>MLModel</code> status. -<code>Name</code> - Sets the search criteria to the contents of <code>MLModel</code><b></b><code>Name</code>. -<code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>MLModel</code> creation. -<code>TrainingDataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used to train one or more <code>MLModel</code>. -<code>RealtimeEndpointStatus</code> - Sets the search criteria to the <code>MLModel</code> real-time endpoint status. -<code>MLModelType</code> - Sets the search criteria to <code>MLModel</code> type: binary, regression, or multi-class. -<code>Algorithm</code> - Sets the search criteria to the algorithm that the <code>MLModel</code> uses. -<code>TrainingDataURI</code> - Sets the search criteria to the data file(s) used in training a <code>MLModel</code>. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.MLModelFilterVariable</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GE</name> <description> <para>The greater than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GT</name> <description> <para>The greater than operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LE</name> <description> <para>The less than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LT</name> <description> <para>The less than operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NE</name> <description> <para>The not equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Prefix</name> <description> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, an <code>MLModel</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>MLModel</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: - 2014-09 - 2014-09-09 - 2014-09-09-Holiday </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SortOrder</name> <description> <para>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>. -<code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). -<code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). Results are sorted by <code>FilterVariable</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.SortOrder</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Limit</name> <description> <para>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>NextToken</name> <description> <para>The ID of the page in the paginated results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>EQ</name> <description> <para>The equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>. </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="False" position="Named"> <name>FilterVariable</name> <description> <para>Use one of the following variables to filter a list of <code>MLModel</code>: -<code>CreatedAt</code> - Sets the search criteria to <code>MLModel</code> creation date. -<code>Status</code> - Sets the search criteria to <code>MLModel</code> status. -<code>Name</code> - Sets the search criteria to the contents of <code>MLModel</code><b></b><code>Name</code>. -<code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>MLModel</code> creation. -<code>TrainingDataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used to train one or more <code>MLModel</code>. -<code>RealtimeEndpointStatus</code> - Sets the search criteria to the <code>MLModel</code> real-time endpoint status. -<code>MLModelType</code> - Sets the search criteria to <code>MLModel</code> type: binary, regression, or multi-class. -<code>Algorithm</code> - Sets the search criteria to the algorithm that the <code>MLModel</code> uses. -<code>TrainingDataURI</code> - Sets the search criteria to the data file(s) used in training a <code>MLModel</code>. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.MLModelFilterVariable</parameterValue> <type> <name>Amazon.MachineLearning.MLModelFilterVariable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>GE</name> <description> <para>The greater than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </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="False" position="Named"> <name>GT</name> <description> <para>The greater than operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>. </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="False" position="Named"> <name>LE</name> <description> <para>The less than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>. </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="False" position="Named"> <name>Limit</name> <description> <para>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>LT</name> <description> <para>The less than operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>. </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="False" position="Named"> <name>NE</name> <description> <para>The not equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>. </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="False" position="Named"> <name>NextToken</name> <description> <para>The ID of the page in the paginated results. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. </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="False" position="Named"> <name>Prefix</name> <description> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, an <code>MLModel</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>MLModel</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: - 2014-09 - 2014-09-09 - 2014-09-09-Holiday </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="False" position="Named"> <name>SortOrder</name> <description> <para>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>. -<code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). -<code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). Results are sorted by <code>FilterVariable</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.SortOrder</parameterValue> <type> <name>Amazon.MachineLearning.SortOrder</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.MLModel</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of MLModel objects. The service call response (type Amazon.MachineLearning.Model.DescribeMLModelsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-MLModelList.html&tocid=Get-MLModelList</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLModelList</code><remarks><para>Description</para><para>-----------</para><para> Returns a list of all Models and their associated data records.</para><para /><para /></remarks> </example> <example> <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\>Get-MLModelList -FilterVariable Status -EQ COMPLETED</code><remarks><para>Description</para><para>-----------</para><para>Returns a list of all Models with a status of COMPLETED.</para><para /><para /></remarks> </example> </examples> </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>Get-MLPrediction</name> <description> <para>Invokes the Predict operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLPrediction</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Generates a prediction for the observation using the specified <code>ML Model</code>. <title>Note</title> Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. </para> </description> <syntax> <syntaxItem> <name>Get-MLPrediction</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>MLModelId</name> <description> <para>A unique identifier of the <code>MLModel</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>PredictEndpoint</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Record</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>MLModelId</name> <description> <para>A unique identifier of the <code>MLModel</code>. </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="False" position="Named"> <name>PredictEndpoint</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </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="False" position="Named"> <name>Record</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue> <type> <name>System.Collections.Hashtable</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.Prediction</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Prediction object. The service call response (type Amazon.MachineLearning.Model.PredictResponse) 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-MLPrediction.html&tocid=Get-MLPrediction</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>Get-MLPrediction -ModelId ID -PredictEndpoint URL -Record @{"A" = "B"; "C" = "D";}</code><remarks><para>Description</para><para>-----------</para><para>Send a record to the realtime prediction endpoint URL for Model with id ID.</para><para /><para /></remarks> </example> </examples> </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>Get-MLResourceTag</name> <description> <para>Invokes the DescribeTags operation against Amazon Machine Learning.</para> </description> <verb>Get</verb> <noun>MLResourceTag</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Describes one or more of the tags for your Amazon ML object. </para> </description> <syntax> <syntaxItem> <name>Get-MLResourceTag</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the ML object. For example, <code>exampleModelId</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the ML object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.TaggableResourceType</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>ResourceId</name> <description> <para>The ID of the ML object. For example, <code>exampleModelId</code>. </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="False" position="Named"> <name>ResourceType</name> <description> <para>The type of the ML object. </para> </description> <parameterValue required="true" variableLength="false">Amazon.MachineLearning.TaggableResourceType</parameterValue> <type> <name>Amazon.MachineLearning.TaggableResourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.MachineLearning.Model.DescribeTagsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.MachineLearning.Model.DescribeTagsResponse 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-MLResourceTag.html&tocid=Get-MLResourceTag</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</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>New-MLBatchPrediction</name> <description> <para>Invokes the CreateBatchPrediction operation against Amazon Machine Learning.</para> </description> <verb>New</verb> <noun>MLBatchPrediction</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a <code>DataSource</code>. This operation creates a new <code>BatchPrediction</code>, and uses an <code>MLModel</code> and the data files referenced by the <code>DataSource</code> as information sources. <code>CreateBatchPrediction</code> is an asynchronous operation. In response to <code>CreateBatchPrediction</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>BatchPrediction</code> status to <code>PENDING</code>. After the <code>BatchPrediction</code> completes, Amazon ML sets the status to <code>COMPLETED</code>. You can poll for status updates by using the <a>GetBatchPrediction</a> operation and checking the <code>Status</code> parameter of the result. After the <code>COMPLETED</code> status appears, the results are available in the location specified by the <code>OutputUri</code> parameter. </para> </description> <syntax> <syntaxItem> <name>New-MLBatchPrediction</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>MLModelId</name> <description> <para>The ID of the <code>MLModel</code> that will generate predictions for the group of observations. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BatchPredictionDataSourceId</name> <description> <para>The ID of the <code>DataSource</code> that points to the group of observations to predict. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BatchPredictionId</name> <description> <para>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BatchPredictionName</name> <description> <para>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>OutputUri</name> <description> <para>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'. Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="http://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" 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="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>BatchPredictionDataSourceId</name> <description> <para>The ID of the <code>DataSource</code> that points to the group of observations to predict. </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="False" position="Named"> <name>BatchPredictionId</name> <description> <para>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. </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="False" position="Named"> <name>BatchPredictionName</name> <description> <para>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set. </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="False" 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 (ByValue, )" position="1"> <name>MLModelId</name> <description> <para>The ID of the <code>MLModel</code> that will generate predictions for the group of observations. </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="False" position="Named"> <name>OutputUri</name> <description> <para>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'. Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="http://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>. </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>System.String</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a String object. The service call response (type Amazon.MachineLearning.Model.CreateBatchPredictionResponse) 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=New-MLBatchPrediction.html&tocid=New-MLBatchPrediction</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> <navigationLink> <linkText>Developer Guide:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/dg/</uri> </navigationLink> <navigationLink> <linkText>Machine Learning Concepts:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/mlconcepts/</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/machine-learning/latest/APIReference/</uri> </navigationLink> </relatedLinks> <examples> <example> <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\>New-MLBatchPrediction -ModelId ID -Name NAME -OutputURI s3://...</code><remarks><para>Description</para><para>-----------</para><para>Create a new batch prediction request for model with id ID and put the output at the specified S3 location.</para><para /><para /></remarks> </example> </examples> </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>New-MLDataSourceFromRDS</name> <description> <para>Invokes the CreateDataSourceFromRDS operation against Amazon Machine Learning.</para> </description> <verb>New</verb> <noun>MLDataSourceFromRDS</noun> <copyright> <para>&copy; Copyright 2008 - 2017 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a <code>DataSource</code> object from an <a href="http://aws.amazon.com/rds/"> Amazon Relational Database Service</a> (Amazon RDS). A <code>DataSource</code> references data that can be used to perform <code>CreateMLModel</code>, <code>CreateEvaluation</code>, or <code>CreateBatchPrediction</code> operations. <code>CreateDataSourceFromRDS</code> is an asynchronous operation. In response to <code>CreateDataSourceFromRDS</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in the <code>COMPLETED</code> or <code>PENDING</code> state can be used only to perform <code>&gt;CreateMLModel</code>>, <code>CreateEvaluation</code>, or <code>CreateBatchPrediction</code> operations. If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <code>GetDataSource</code> operation response. </para> </description> <syntax> <syntaxItem> <name>New-MLDataSourceFromRDS</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>ComputeStatistic</name> <description> <para>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training. This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DatabaseInformation_DatabaseName</name> <description> <para>Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>RDSData_DataRearrangement</name> <description> <para>A JSON string that represents the splitting and rearrangement processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code> parameter is not provided, all of the input data is used to create the <code>Datasource</code>. There are multiple parameters that control what data is used to create a datasource: - <b><code>percentBegin</code></b> Use <code>percentBegin</code> to indicate the beginning of the range of the data used to create the Datasource. If you do not include <code>percentBegin</code> and <code>percentEnd</code>, Amazon ML includes all of the data when creating the datasource. - <b><code>percentEnd</code></b> Use <code>percentEnd</code> to indicate the end of the range of the data used to create the Datasource. If you do not include <code>percentBegin</code> and <code>percentEnd</code>, Amazon ML includes all of the data when creating the datasource. - <b><code>complement</code></b> The <code>complement</code> parameter instructs Amazon ML to use the data that is not included in the range of <code>percentBegin</code> to <code>percentEnd</code> to create a datasource. The <code>complement</code>
